FUNCTION BindVariable(src$, col$, var$)    
 | 
 
FUNCTION BindVariable(src$, col$, var$, tmpCtl)    
 | 
 
FUNCTION CheckMainTable()    
Basic check that OpenMainTable did not fail and cFH is not zero.
This is a workaround for an issue where the EXIT errOBJECT is ignored in pvxcom.
 
 | 
 
    | Returns | 
    [bool] True if the open channel can be validated, otherwise false. | 
 
  
 | 
 
FUNCTION Clear()    
 | 
 
FUNCTION Find()    
 | 
 
FUNCTION Find(key$)    
 | 
 
FUNCTION FindById(hexKey$)    
Accepts a hex encoded key, converts it to ASCII and calls _OBJ'Find(key$) with the converted ASCII value.
 
 | 
 
| Parameter | Description |  
    | hexKey$ | 
    [input,string] Hex encoded key value. | 
 
  
 | 
 
    | Returns | 
    [bool] Success if the key was found, otherwise failure. | 
 
  
 | 
 
FUNCTION GetChildHandle(src$)    
 | 
 
FUNCTION GetChildKeyReference$(src$)    
 | 
 
FUNCTION GetColumns$(src$)    
 | 
 
FUNCTION GetDataSources$()    
 | 
 
FUNCTION GetDataSourcesAddl$()    
 | 
 
FUNCTION GetJson$(columns$)    
 | 
 
FUNCTION GetJson$()    
Returns a JSON representation of the current record (requires the key/record to be set).
 
 | 
 
| Parameter | Description |  
    | columns$ | 
    [input, string] Optional comma separated list of column names for the current object. Default is all columns for the current object. | 
 
  
 | 
 
    | Returns | 
    [string] JSON formatted string containing the data if successfull or an error if not. | 
 
  
 | 
 
FUNCTION GetKey$()    
 | 
 
FUNCTION GetKey$(fromIndex$)    
 | 
 
FUNCTION GetKeyColumns$()    
 | 
 
FUNCTION GetKeyPadded$()    
 | 
 
FUNCTION GetPartialRecord(record$, iol$)    
 | 
 
FUNCTION GetRecord(record$, iol$)    
 | 
 
FUNCTION GetRecordCount(src$)    
 | 
 
FUNCTION GetRecordEx(record$, iol$)    
Extended version of GetRecord that prepends the returned record and iolist with:
Id$ - The hex value of the current key.
FormattedCode$ - The result of EVS("cCodeFormat$", ERR=*NEXT)
FormattedName$ - The result of EVS("cNameFormat$", ERR=*NEXT)
 
 | 
 
FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$)    
 | 
 
FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$, alternateIndex$)    
 | 
 
FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$, alternateIndex$, distinctOnly)    
 | 
 
FUNCTION GetTable$(src$)    
 | 
 
FUNCTION GetTablePath$(src$)    
 | 
 
FUNCTION GetValue(col$, val$)    
 | 
 
FUNCTION GetValue(col$, val)    
 | 
 
FUNCTION GetValues(columns$, data$)    
Alternate method to GetPartialRecord(), but can pass in a comma-separated list of column names, instead of a compiled Providex IOList.
 
 | 
 
| Parameter | Description |  
    | columns$ | 
    [input/output, string] comma separated list of field names for the current object, these will be compiled into an IOList and the data returned. If thie list sent in does not have $ on the string variables these will be converted and sent back in this argument. | 
 
    | data$ | 
    [output, string] SEP (hex 8A), separated list of data that was requested. | 
 
  
 | 
 
    | Returns | 
    [boolean] Success - if data was returned from the list of fields given.  Failure - if IOList could not be compiled due to a bad list of fields. | 
 
  
 | 
 
FUNCTION IsValid()    
 | 
 
FUNCTION IsValid(key$)    
 | 
 
FUNCTION IsValid(key$, fromCols$, toCols$)    
 | 
 
FUNCTION MoveFirst()    
 | 
 
FUNCTION MoveLast()    
 | 
 
FUNCTION MoveNext()    
 | 
 
FUNCTION MovePrevious()    
 | 
 
FUNCTION ReadAdditional()    
 | 
 
FUNCTION ReadAdditional(src$)    
 | 
 
FUNCTION SetBrowseFilter(browseFilter$)    
 | 
 
FUNCTION SetBrowseIndex(newBrowseIndex$, newIndex$)    
 | 
 
FUNCTION SetCacheMode(cacheMode$)    
 | 
 
FUNCTION SetIndex(newIndex$)    
 | 
 
FUNCTION SetKeyValue(col$, val$)    
 | 
 
FUNCTION SetParentColumns()    
 | 
 
FUNCTION SetParentColumns(fromCols$, toCols$)    
 | 
 
FUNCTION SetParentHandle(parentTable$, parentHandle, src$, srcMap$, dstMap$)    
 | 
 
FUNCTION SetUIHandle(uIHandle)    
 | 
 
FUNCTION LOCAL PERFORM ClearEditRcd()    
 | 
 
FUNCTION LOCAL FormatJson$(columns$)    
Local function to format the column values, dates, strings, numbers, for the current record into JSON format.
 
 | 
 
| Parameter | Description |  
    | columns$ | 
    [input, string] Comma separated list of column names for the current object to return data for. | 
 
  
 | 
 
    | Returns | 
    [string] JSON formatted string containing the data if successfull or an error if not. | 
 
  
 | 
 
FUNCTION LOCAL GetAddlDataSources()    
 | 
 
FUNCTION LOCAL GetDateColumns$(columns$)    
 | 
 
FUNCTION LOCAL InitChildCollection(childId$, className$, keyReference$, index$, fil$)    
 | 
 
FUNCTION LOCAL InitChildCollection(childId$, className$, keyReference$, index$, fil$, srcMap$, dstMap$)    
 | 
 
FUNCTION LOCAL MoveFirstLast(direction)    
 | 
 
FUNCTION LOCAL MoveNextPrevious(direction)    
 | 
 
FUNCTION LOCAL OpenMainTable()    
 | 
 
FUNCTION LOCAL ParseKeyDef(newIndex$)    
 | 
 
FUNCTION LOCAL ParseKeyDef(newIndex$, mainTblFH)    
 | 
 
FUNCTION LOCAL PrepareKeyDef(tblFH)    
 | 
 
FUNCTION LOCAL ReadRec(key$)    
 | 
 
FUNCTION LOCAL ResolveColumnList$(columns$)    
Resolves whether individual columns, in a list if they do not include a $ for the string name (ie CustomerName vs CustomerName$), thus can put string names without the $ in a list of fields and they can be verified here and changed if the field is in the iolist of cFH, otherwise it will remain unchanged.
 
 | 
 
| Parameter | Description |  
    | columns$ | 
    [input, string] Comma separated list of variable names, the string names, that are columns in the main table do not have to include the '$' | 
 
  
 | 
 
    | Returns | 
    On Success: returns a comma separated list of uppercase variable names, converting the string names that came in to include the $ | 
 
  
 | 
 
FUNCTION LOCAL SetControls()    
 | 
 
FUNCTION LOCAL SetCurrentKey(key$)    
 | 
 
FUNCTION LOCAL UseKeyColl(method$)    
 |