JegasAPI - Jegas, LLC - Copyright(c)2016

Unit uj_modules

DescriptionUsesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

JAS Specific Functions

Overview

Functions and Procedures

function bGet_Module_ID_With_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; var p_JModu_JModule_UID: ansistring ): boolean;
function bGet_Module_Name_With_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; var p_JModu_Name: ansistring ): boolean;
function bGet_Installed_Instances_For_Given_Module_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; p_bReturnEnabledInstalledInstancesOnly: boolean; var p_XDL: JFC_XDL ): boolean;
function bGet_Installed_Instances_For_Given_Module_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; p_bReturnEnabledInstalledInstancesOnly: boolean; var p_XDL: JFC_XDL ): boolean;
function bGet_Setting_List_For_Given_Module_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; var p_XDL: JFC_XDL ): boolean;
function bGet_Setting_List_For_Given_Module_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; var p_XDL: JFC_XDL ): boolean;
function bGet_ModuleConfig_Values_For_Given_Install( p_Context: TCONTEXT; p_JInst_JInstalled_UID: ansistring; var p_XDL: JFC_XDL ): boolean;
function bGet_ModuleConfig_Value_For_Given_Install( p_Context: TCONTEXT; p_JInst_JInstalled_UID: ansistring; p_JMSet_Name: ansistring; var p_saValue: ansistring; var p_saNotes: ansistring ): boolean;

Description

Functions and Procedures

function bGet_Module_ID_With_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; var p_JModu_JModule_UID: ansistring ): boolean;

Returns the JModule.JModu_JModule_UID of the requested JModule.JModu_Name. The search is exact. If data permits multiple rows that match the criteria, only the first row is returned. Duplicates should not be present. Returns true if successful, false if not.

function bGet_Module_Name_With_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; var p_JModu_Name: ansistring ): boolean;

Returns the JModule.JModu_Name of the requested JModule.JModu_JModule_UID. Exact Match. Returns true if successful, false if not.

function bGet_Installed_Instances_For_Given_Module_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; p_bReturnEnabledInstalledInstancesOnly: boolean; var p_XDL: JFC_XDL ): boolean;

This function returns an instantiated JFC_XDL. Upon entry, if the p_XDL parameter is not nil a p_XDL.Destroy will be executed upon it assuming it is an instantiated JFC_XDL object. So be sure to set your JFC_XDL variable to nil before calling this function or expect an exception when this function tries to blast your unintialized pointer thinking it's an Instantiated JFC_XDL Object. The p_ReturnEnabledInstalledInstancesOnly parameter is how you indicate if you want the function to only return results for a given Installed Module instance if it's in fact enabled. If an error occurs, the p_XDL object will be destroyed and returned as nil. If this function returns True (No Error) - It WILL return an instantiated JFC_XDL object.. with ZERO items in it. JFC_XDL object.. with ZERO items in it. JFC_XDL.Item_saName = 'Name of Module' (which you already probably know) JFC_XDL.Item_saValue = jinstalled.JInst_JModule_UID Returns true if successful, false if not.

function bGet_Installed_Instances_For_Given_Module_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; p_bReturnEnabledInstalledInstancesOnly: boolean; var p_XDL: JFC_XDL ): boolean;

Returns the JModule.JModu_Name of the requested JModule.JModu_JModule_UID. Exact Match. This function returns an instantiated JFC_XDL. Upon entry, if the p_XDL parameter is not nil a p_XDL.Destroy will be executed upon it assuming it is an instantiated JFC_XDL object. So be sure to set your JFC_XDL variable to nil before calling this function or expect an exception when this function tries to blast your unintialized pointer thinking it's an Instantiated JFC_XDL Object. The p_ReturnEnabledInstalledInstancesOnly parameter is how you indicate if you want the function to only return results for a given Installed Module instance if it's in fact enabled. Returns true if successful, false if not.

function bGet_Setting_List_For_Given_Module_Name( p_Context: TCONTEXT; p_JModu_Name: ansistring; var p_XDL: JFC_XDL ): boolean;

Returns a Populated JFC_XDL object of all the settings possible for a given module name. This doesn't return the setting values for a particular Module's Installation Instance.. just the settings the given Module has associated with it. This function returns an instantiated JFC_XDL. Upon entry, if the p_XDL parameter is not nil a p_XDL.Destroy will be executed upon it assuming it is an instantiated JFC_XDL object. So be sure to set your JFC_XDL variable to nil before calling this function or expect an exception when this function tries to blast your unintialized pointer thinking it's an Instantiated JFC_XDL Object. Returns true if successful, false if not.

function bGet_Setting_List_For_Given_Module_ID( p_Context: TCONTEXT; p_JModu_JModule_UID: ansistring; var p_XDL: JFC_XDL ): boolean;

Returns a Populated JFC_XDL object of all the settings possible for a given module ID. This doesn't return the setting values for a particular Module's Installation Instance.. just the settings the given Module has associated with it. This function returns an instantiated JFC_XDL. Upon entry, if the p_XDL parameter is not nil a p_XDL.Destroy will be executed upon it assuming it is an instantiated JFC_XDL object. So be sure to set your JFC_XDL variable to nil before calling this function or expect an exception when this function tries to blast your unintialized pointer thinking it's an Instantiated JFC_XDL Object. Returns true if successful, false if not. p_XDL.Item_i8User:=i8Val(rs.fields.Get_saValue('JMSet_JCaption_ID')); p_XDL.Item_saName:=rs.fields.Get_saValue('JMSet_Name'); p_XDL.Item_saValue:=rs.fields.Get_saValue('JMSet_JModuleSetting_UID'); p_XDL.Item_saDesc:=i8Val(rs.fields.Get_saValue('JMSet_JNote_ID'));

function bGet_ModuleConfig_Values_For_Given_Install( p_Context: TCONTEXT; p_JInst_JInstalled_UID: ansistring; var p_XDL: JFC_XDL ): boolean;

Returns a Populated JFC_XDL object of all the settings for a given Module Install instance. This function returns actual configuration values for each setting. This function returns an instantiated JFC_XDL. Upon entry, if the p_XDL parameter is not nil a p_XDL.Destroy will be executed upon it assuming it is an instantiated JFC_XDL object. So be sure to set your JFC_XDL variable to nil before calling this function or expect an exception when this function tries to blast your unintialized pointer thinking it's an Instantiated JFC_XDL Object. Returns true if successful, false if not.

function bGet_ModuleConfig_Value_For_Given_Install( p_Context: TCONTEXT; p_JInst_JInstalled_UID: ansistring; p_JMSet_Name: ansistring; var p_saValue: ansistring; var p_saNotes: ansistring ): boolean;

Returns specific setting's configuration value for a given Module Install instance and setting name combination. This function returns an instantiated JFC_XDL. Returns true if successful, false if not or if anything is missing. E.G. p_JInst_JInstalled_UID can't be found p_JMSet_Name can't be found or Actual setting value record can not be found.

http://www.jegas.com
Generated by PasDoc 0.14.0.