Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ServiceDescription
NewLog

Usage:
Logging_Services('NewLog',LogPath, LogFileName, RowDelimiter, ColumnDelimiter, ColumnHeaders, ColumnWidths, QuoteValues, ClearLog)

Comments:
Performs a health check against all attached tables and returns back any issuesReturns an object handle to a log file.

Returns:
Returns two lists which are delimited by an @RM. The first list is an @FM list of attached tables. The second list is an @FM list of results (groups that have GFEs or an empty string if there are none). Items in each list correspond which each other based on their list positionSee comments.

AppendLog

Usage:
Logging_Services('AppendLog', Tablenames, SaveList, objLog, LogData, IncomingRowDelimiter, IncomingColumnDelimiter, IgnoreColumnHeaders)

Comments:
Performs a health check against the indicated tables and returns back any issues. Note: This uses the Verify_LH subroutine to check for GFEs. All results are stored in the SYSLHVERIFY table with a KeyID of VolumeLabel*DatabaseID*TableName. Returns the list of groups that have GFEs or returns an empty string if there are none. The list of GFEs or empty strings will themselves be @FM delimited to correspond with the tables passed into this service.Appends data to the log file associated with the indicated log object handle.

Returns:
N/AReturns:
An @FM delimited array of table names and associated GFE information.

GetLogPath

Usage:
Logging_Services('GetLogPath', TableNameobjLog)

Comments:
Returns an array of information related to the database table being passed inthe path for the log file associated with the indicated log object handle. This will not include the name of the log file itself.

Returns:
An @FM delimited array of table information:

AttributeDescription
<1>Database ID
<2>MFS/BFS list
<3>Volume Label (if available)
<4>Volume Path (if available)
<5>BFS (if available)

See comments.

GetLogFileName

Usage:
Logging_Services('GetLogFileName', TableNameobjLog)

Comments:
Returns an array of information related to the database table being passed inthe file name for the log file associated with the indicated log object handle. This will not include the path to where the log file is located.

Returns:
The handle array created by the Open statementSee comments.

GetLogFullPath

Usage:
Logging_Services('GetLogFullPath', TableNameobjLog)

Comments:
Clears the table handle array array from cache. This will force the GetTableHandle service to call the Open statement againReturns the full path for the log file associated with the indicated log object handle.

Returns:
N/ASee comments.

GetRowDelimiter

Usage:
Logging_Services('GetRowDelimiter', KeyID, NotExpired, ExpirationDuration, IgnoreMFSRoutinesobjLog)

Comments:
Reads a data row for the indicated Key ID and database tableReturns the delimiter to use to separate each row in the log.

Returns:
The requested data rowSee comments.

GetColumnDelimiter

Usage:
Logging_Services('GetColumnDelimiter', TableName, KeyID, DataRow, IgnoreSelfLock, IgnoreMFSRoutines, IgnoreAllLocksobjLog)

Comments:
Writes a data row for the indicated Key ID and database tableReturns the delimiter to use to separate each column in the log.

Returns:
N/ASee comments.

GetColumnHeaders

Usage:
Logging_Services('GetColumnHeaders', TableName, KeyID, IgnoreSelfLock, IgnoreMFSRoutinesobjLog)

Comments:
Deletes a data row for the indicated Key ID and database tableReturns the column headers that should be in the log.

Returns:
N/ASee comments.

GetColumnWidths

Usage:
Logging_Services('GetColumnWidths', TableName, KeyID, IgnoreSelfLockobjLog)

Comments:
Attempts to perform a semaphore lock on the indicated tablename and Key IDReturns the column widths that should be used to truncate or pad each column in the log.

Returns:
A Boolean flag indicating if the lock request was successfully performedSee comments.

GetQuoteValues

Usage:
Logging_Services('GetQuoteValues', TableName, KeyIDobjLog)

Comments:
Attempts to release a semaphore lock on the indicated tablename and Key IDReturns the flag to indicate whether column values should be quoted or not.

Returns:
A Boolean flag indicating if the lock release was successfully performedSee comments.

CreateLogFile

Usage:
Logging_Services('CreateLogFile', TableName, AliasName, Volume, DatabaseIDobjLog)

Comments:
Attempts to create an alias for the indicated table, volume, and database. It returns a True$ if successful or a False$ if unsuccessfulCreates (or clears out) a log file associated with the indicated log object handle.

Returns:
A Boolean flag indicating if the alias request was successfully performed.N/A

Params

The proper use of the generic arguments are defined in the definition of each service above.

...