JegasAPI - www.jegas.com

Class JFC_XDL

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type JFC_XDL = class(JFC_DL)

Description

Base JFC_XDL class

Hierarchy

Overview

Fields

Public i8User: int64;

Methods

Public Constructor create;
Public Destructor Destroy; override;
Public Function AppendItem_i8User(p_i8User: Int64): Boolean;
Public Function AppendItem_saName(p_saName:AnsiString):Boolean;
Public Function AppendItem_saName_N_saDesc(p_saName, p_saDesc: AnsiString): Boolean;
Public Function AppendItem_saName_N_saValue(p_saName, p_saValue: AnsiString): Boolean;
Public Function AppendItem_saName_saValue_saDesc(p_saName, p_saValue, p_saDesc: AnsiString): Boolean;
Public Function AppendItem_saValue(p_saValue:AnsiString):Boolean;
Public Function AppendItem_SNRPair( p_saSearchFor, p_saReplacewith: AnsiString): Boolean;
Public Function AppendItem_XDL(p_lpPtr: pointer; p_saName, p_saValue, p_saDesc: AnsiString; p_i8User: Int64 ): Boolean;
Public Function FNextItem_i8User(p_i8:Int64): Boolean;
Public Function FNextItem_saDesc(p_sa:AnsiString):Boolean;
Public Function FNextItem_saDesc(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FNextItem_saName(p_sa:AnsiString):Boolean;
Public Function FNextItem_saName(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FNextItem_saName_N_saDesc( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saDesc: AnsiString; p_bDescCaseSensitive: Boolean ):Boolean;
Public Function FNextItem_saName_N_saValue( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saValue: AnsiString; p_bValueCaseSensitive: Boolean ):Boolean;
Public Function FNextItem_saValue(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FNextItem_saValue(p_sa:AnsiString):Boolean;
Public Function FoundItem_i8User(p_i8:Int64): Boolean;
Public Function FoundItem_saDesc(p_sa:AnsiString):Boolean;
Public Function FoundItem_saDesc(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FoundItem_saName(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FoundItem_saName(p_sa:AnsiString):Boolean;
Public Function FoundItem_saName_N_saDesc( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saDesc: AnsiString; p_bDescCaseSensitive: Boolean ):Boolean;
Public Function FoundItem_saName_N_saValue( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saValue: AnsiString; p_bValueCaseSensitive: Boolean ):Boolean;
Public Function FoundItem_saValue(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;
Public Function FoundItem_saValue(p_sa:AnsiString):Boolean;
Public Function FoundItem_TS(p_tsFrom, p_tsTo: TTIMESTAMP):Boolean;
Public Function FoundItem_UID(p_u8: UInt64):Boolean;
Public Function FoundNext_TS(p_tsTo:TTIMESTAMP):Boolean;
Public function Get_Item(p_saName: ansistring): pointer;
Public function Get_ItemCS(p_saName: ansistring): pointer;
Public Function Get_saDesc(p_saName: AnsiString):AnsiString;
Public Function Get_saDescCS(p_saName: AnsiString):AnsiString;
Public Function Get_saValue(p_saName: AnsiString):AnsiString;
Public Function Get_saValueCS(p_saName: AnsiString):AnsiString;
Public Function InsertItem_i8User(p_i8User: Int64): Boolean;
Public Function InsertItem_saName(p_saName:AnsiString):Boolean;
Public Function InsertItem_saName_N_saDesc(p_saName, p_saDesc: AnsiString): Boolean;
Public Function InsertItem_saName_N_saValue(p_saName, p_saValue: AnsiString): Boolean;
Public Function InsertItem_saName_saValue_saDesc(p_saName, p_saValue, p_saDesc: AnsiString): Boolean;
Public Function InsertItem_saValue(p_saValue:AnsiString):Boolean;
Public Function InsertItem_SNRPair( p_saSearchFor, p_saReplacewith: AnsiString): Boolean;
Public Function InsertItem_XDL(p_lpPtr: pointer; p_saName, p_saValue, p_saDesc: AnsiString; p_i8User: Int64 ): Boolean;
Public Function pvt_CreateItem: JFC_XDLITEM; override;
Public Function read_item_i8User: Int64;
Public Function read_item_sadesc: AnsiString;
Public Function read_item_saname: AnsiString;
Public Function read_item_savalue: AnsiString;
Public Function read_item_UID: UInt64;
Public Function saHTMLTable: AnsiString;
Public Function saHTMLTable( p_saTableTagInsert: AnsiString; p_bTableCaption: Boolean; p_saTableCaption: AnsiString; p_bTableCaptionShowRowCount: Boolean; p_bTableHEAD: Boolean; p_saNHEADText: AnsiString; p_u1NCol: byte; p_salpPTRHEADText: AnsiString; p_u1lpPtrCol: byte; p_saUIDHEADText: AnsiString; p_u1UIDCol: byte; p_sasaNameHEADText: AnsiString; p_u1saNameCol: byte; p_sasaValueHEADText: AnsiString; p_u1saValueCol: byte; p_sasaDescHEADText: AnsiString; p_u1saDescCol: byte; p_sai8UserHEADText: AnsiString; p_u1i8UserCol: byte; p_saTSHEADText: AnsiString; p_u1TSCol: byte ):AnsiString;
Public Function saXML: AnsiString;
Public Function SNR(p_sa:AnsiString; p_bCaseSensitive:Boolean): AnsiString;
Public Function SortItem_saDesc( p_bCaseSensitive: Boolean; p_bAscending: Boolean):Boolean;
Public Function SortItem_saName( p_bCaseSensitive: Boolean; p_bAscending: Boolean ):Boolean;
Public Function SortItem_saValue( p_bCaseSensitive: Boolean; p_bAscending: Boolean):Boolean;
Public Procedure DumpToTextFile(p_sa: AnsiString);
Public Procedure DumpToTextFile(p_sa:AnsiString; Var p_u2IOResult: Word);
Public Procedure LoadXDLWithEnvVar;
Public Procedure LoadXDLWithParams;
Public Procedure pvt_createtask; override;
Public Procedure pvt_DestroyItem(p_lp:pointer); override;
Public Procedure pvt_destroytask(p_lp:pointer); override;
Public procedure Set_saDesc(p_saName: AnsiString; p_saDesc: ansistring);
Public procedure Set_saDescCS(p_saName: AnsiString; p_saDesc: ansistring);
Public procedure Set_saValue(p_saName: AnsiString; p_saValue: ansistring);
Public procedure Set_saValueCS(p_saName: AnsiString; p_saValue: ansistring);
Public Procedure write_item_i8User(p_i8: Int64);
Public Procedure write_item_sadesc(p_sa:AnsiString);
Public Procedure write_item_saname(p_sa: AnsiString);
Public Procedure write_item_savalue(p_sa:AnsiString);

Properties

Public property Item_i8User: Int64 read read_item_i8User Write write_item_i8User;
Public property Item_saDesc: AnsiString read read_item_saDesc Write write_item_sadesc;
Public property Item_saName: AnsiString read read_item_saname Write write_item_saname;
Public property Item_saValue: AnsiString read read_item_savalue Write write_item_savalue;
Public property Item_UID: UInt64 read read_item_UID;

Description

Fields

Public i8User: int64;

=============================================================================

Methods

Public Constructor create;

OVERRIDE BUT INHERIT

Public Destructor Destroy; override;

OVERRIDE BUT INHERIT

Public Function AppendItem_i8User(p_i8User: Int64): Boolean;
 
Public Function AppendItem_saName(p_saName:AnsiString):Boolean;
 
Public Function AppendItem_saName_N_saDesc(p_saName, p_saDesc: AnsiString): Boolean;
 
Public Function AppendItem_saName_N_saValue(p_saName, p_saValue: AnsiString): Boolean;
 
Public Function AppendItem_saName_saValue_saDesc(p_saName, p_saValue, p_saDesc: AnsiString): Boolean;
 
Public Function AppendItem_saValue(p_saValue:AnsiString):Boolean;
 
Public Function AppendItem_SNRPair( p_saSearchFor, p_saReplacewith: AnsiString): Boolean;
 
Public Function AppendItem_XDL(p_lpPtr: pointer; p_saName, p_saValue, p_saDesc: AnsiString; p_i8User: Int64 ): Boolean;
 
Public Function FNextItem_i8User(p_i8:Int64): Boolean;

Search for next item with Matching i8User Value. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saDesc(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FNextItem_saDesc(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find Next matching item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saName(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FNextItem_saName(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find Next Matching Item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saName_N_saDesc( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saDesc: AnsiString; p_bDescCaseSensitive: Boolean ):Boolean;

This finds next item with matching criteria for both Name and Desc fields. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saName_N_saValue( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saValue: AnsiString; p_bValueCaseSensitive: Boolean ):Boolean;

Find Next Match This Finds Name & Value At Same Time This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saValue(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find Next matching item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FNextItem_saValue(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FoundItem_i8User(p_i8:Int64): Boolean;

Search for first item with matching i8User Value. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saDesc(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FoundItem_saDesc(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find first matching item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saName(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find first matching item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saName(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FoundItem_saName_N_saDesc( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saDesc: AnsiString; p_bDescCaseSensitive: Boolean ):Boolean;

This finds first item with matching criteria for both Name and Desc fields. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saName_N_saValue( p_saName: AnsiString; p_bNameCaseSensitive: Boolean; p_saValue: AnsiString; p_bValueCaseSensitive: Boolean ):Boolean;

Find first match This Finds Name & Value At Same Time This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saValue(p_sa:AnsiString;p_bCaseSensitive:Boolean):Boolean;

Find first matching item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_saValue(p_sa:AnsiString):Boolean;

Find first matching item. NOT CASE Sensistive

Public Function FoundItem_TS(p_tsFrom, p_tsTo: TTIMESTAMP):Boolean;

Search for First item with matching TimeStamp - This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundItem_UID(p_u8: UInt64):Boolean;

Find Matching Item. This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public Function FoundNext_TS(p_tsTo:TTIMESTAMP):Boolean;

Search for Next matching TimeStamp - This Search is Offered for convienence; the Tricky Pointer Calling convention stuff is handled for you. In short there are calls that are generic for doing binary and text searches on any data element you like but you need to handle pointers correctly to get them working. This routine that work was done for you and provided as a clean wrapper.

Public function Get_Item(p_saName: ansistring): pointer;

Function saXML( p_saRootPropertyInsert: AnsiString;

p_bTableCaption: Boolean; p_saTableCaption: AnsiString; p_bTableCaptionShowRowCount: Boolean;

p_saNHEADText: AnsiString; p_u1NCol: byte;

p_salpPTRHEADText: AnsiString; p_u1lpPtrCol: byte;//< zero = Don't Display

p_saUIDHEADText: AnsiString; p_u1UIDCol: byte;

p_sasaNameHEADText: AnsiString; p_u1saNameCol: byte;

p_sasaValueHEADText: AnsiString; p_u1saValueCol: byte;

p_sasaDescHEADText: AnsiString; p_u1saDescCol: byte;

p_sai8UserHEADText: AnsiString; p_u1i8UserCol: byte; ):AnsiString;

Public function Get_ItemCS(p_saName: ansistring): pointer;
 
Public Function Get_saDesc(p_saName: AnsiString):AnsiString;
 
Public Function Get_saDescCS(p_saName: AnsiString):AnsiString;
 
Public Function Get_saValue(p_saName: AnsiString):AnsiString;
 
Public Function Get_saValueCS(p_saName: AnsiString):AnsiString;
 
Public Function InsertItem_i8User(p_i8User: Int64): Boolean;
 
Public Function InsertItem_saName(p_saName:AnsiString):Boolean;
 
Public Function InsertItem_saName_N_saDesc(p_saName, p_saDesc: AnsiString): Boolean;
 
Public Function InsertItem_saName_N_saValue(p_saName, p_saValue: AnsiString): Boolean;
 
Public Function InsertItem_saName_saValue_saDesc(p_saName, p_saValue, p_saDesc: AnsiString): Boolean;
 
Public Function InsertItem_saValue(p_saValue:AnsiString):Boolean;
 
Public Function InsertItem_SNRPair( p_saSearchFor, p_saReplacewith: AnsiString): Boolean;
 
Public Function InsertItem_XDL(p_lpPtr: pointer; p_saName, p_saValue, p_saDesc: AnsiString; p_i8User: Int64 ): Boolean;
 
Public Function pvt_CreateItem: JFC_XDLITEM; override;

Override if you make descendant of JFC_DLITEM with more fields or something.

Public Function read_item_i8User: Int64;

make properties work

Public Function read_item_sadesc: AnsiString;

make properties work

Public Function read_item_saname: AnsiString;

make properties work

Public Function read_item_savalue: AnsiString;

make properties work

Public Function read_item_UID: UInt64;

make properties work

Public Function saHTMLTable: AnsiString;

Create HTML to make a Diagnostic or whatever table of the XDL Contents. This is a barebones mostly fixed implementation.

Public Function saHTMLTable( p_saTableTagInsert: AnsiString; p_bTableCaption: Boolean; p_saTableCaption: AnsiString; p_bTableCaptionShowRowCount: Boolean; p_bTableHEAD: Boolean; p_saNHEADText: AnsiString; p_u1NCol: byte; p_salpPTRHEADText: AnsiString; p_u1lpPtrCol: byte; p_saUIDHEADText: AnsiString; p_u1UIDCol: byte; p_sasaNameHEADText: AnsiString; p_u1saNameCol: byte; p_sasaValueHEADText: AnsiString; p_u1saValueCol: byte; p_sasaDescHEADText: AnsiString; p_u1saDescCol: byte; p_sai8UserHEADText: AnsiString; p_u1i8UserCol: byte; p_saTSHEADText: AnsiString; p_u1TSCol: byte ):AnsiString;

Uses Defaults Create HTML to make a Diagnostic or whatever table of the XDL Contents. This is a barebones mostly fixed implementation - but this version gives you much more control of the output than the version that doesn't take parameters.

Public Function saXML: AnsiString;

Create xml to make a Diagnostic or whatever table of the XDL Contents. This is a barebones mostly fixed implementation.

Public Function SNR(p_sa:AnsiString; p_bCaseSensitive:Boolean): AnsiString;

NOW this is kinda special! Yes - Its a search and Replace routine BUT This is for when You Want to do MULTIPLE Searches and replaces to a string with ONE CALL! How It works is simple - First - Create an Instance of this class naturally - THEN Create "ITEMS". The important fields here are saName and saValue. Each "Item" in the linked list is a SEARCHFOR and REPLACEWITH parameter pair. Put SEARCHFOR string in saName and REPLACEWITH string in saValue - Add as many as you want THEN call this routine with the string you want SEARCH'd and Replace'd it returns the CONVERTED result back to you. This Definately is special purpose - it was intended to give a WHOLE new Reason to use this class.

Public Function SortItem_saDesc( p_bCaseSensitive: Boolean; p_bAscending: Boolean):Boolean;
 
Public Function SortItem_saName( p_bCaseSensitive: Boolean; p_bAscending: Boolean ):Boolean;
 
Public Function SortItem_saValue( p_bCaseSensitive: Boolean; p_bAscending: Boolean):Boolean;
 
Public Procedure DumpToTextFile(p_sa: AnsiString);
 
Public Procedure DumpToTextFile(p_sa:AnsiString; Var p_u2IOResult: Word);
 
Public Procedure LoadXDLWithEnvVar;

This procedure empties the list and loads it with the current ENV Variables.

Public Procedure LoadXDLWithParams;

This procedure empties the list and loads it with parameters passed to the program from the command line.

Public Procedure pvt_createtask; override;

Override if you make descendant of JFC_DLITEM with more fields or something.

Public Procedure pvt_DestroyItem(p_lp:pointer); override;

Override if you make descendant of JFC_DLITEM with more fields or something.

Public Procedure pvt_destroytask(p_lp:pointer); override;

Override if you make descendant of JFC_DLITEM with more fields or something.

Public procedure Set_saDesc(p_saName: AnsiString; p_saDesc: ansistring);
 
Public procedure Set_saDescCS(p_saName: AnsiString; p_saDesc: ansistring);
 
Public procedure Set_saValue(p_saName: AnsiString; p_saValue: ansistring);
 
Public procedure Set_saValueCS(p_saName: AnsiString; p_saValue: ansistring);
 
Public Procedure write_item_i8User(p_i8: Int64);

make properties work

Public Procedure write_item_sadesc(p_sa:AnsiString);

make properties work

Public Procedure write_item_saname(p_sa: AnsiString);

make properties work

Public Procedure write_item_savalue(p_sa:AnsiString);

make properties work

Properties

Public property Item_i8User: Int64 read read_item_i8User Write write_item_i8User;

No Checks Are made - Using this property when the list is empty will cause a runtime error.

Public property Item_saDesc: AnsiString read read_item_saDesc Write write_item_sadesc;

No Checks Are made - Using this property when the list is empty will cause a runtime error.

Public property Item_saName: AnsiString read read_item_saname Write write_item_saname;

No Checks Are made - Using this property when the list is empty will cause a runtime error.

Public property Item_saValue: AnsiString read read_item_savalue Write write_item_savalue;

No Checks Are made - Using this property when the list is empty will cause a runtime error.

Public property Item_UID: UInt64 read read_item_UID;

No Checks Are made - Using this property when the list is empty will cause a runtime error.

JegasAPI - www.jegas.com
Generated by PasDoc 0.14.0.