Service module to create OS log files.

Syntax

Response = Logging_Services(@Service, @Params)

Returns

The meaning of the response value depends on the service.

Parameters

ParameterDescription
@ServiceThe name of the service being requested. Required.
@ParamsGeneric parameters. Refer to a specific service to determine the actual parameters used.

Remarks

This module provides several useful services for creating and appending log files.

Services

ServiceDescription
NewLog

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

Comments:
Returns an object handle to a log file.

Returns:
See comments.

AppendLog

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

Comments:
Appends data to the log file associated with the indicated log object handle.

Returns:
N/A

GetLogPath

Usage:
Logging_Services('GetLogPath', objLog)

Comments:
Returns the path for the log file associated with the indicated log object handle. This will not include the name of the log file itself.

Returns:
See comments.

GetLogFileName

Usage:
Logging_Services('GetLogFileName', objLog)

Comments:
Returns the 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:
See comments.

GetLogFullPath

Usage:
Logging_Services('GetLogFullPath', objLog)

Comments:
Returns the full path for the log file associated with the indicated log object handle.

Returns:
See comments.

GetRowDelimiter

Usage:
Logging_Services('GetRowDelimiter', objLog)

Comments:
Returns the delimiter to use to separate each row in the log.

Returns:
See comments.

GetColumnDelimiter

Usage:
Logging_Services('GetColumnDelimiter', objLog)

Comments:
Returns the delimiter to use to separate each column in the log.

Returns:
See comments.

GetColumnHeaders

Usage:
Logging_Services('GetColumnHeaders', objLog)

Comments:
Returns the column headers that should be in the log.

Returns:
See comments.

GetColumnWidths

Usage:
Logging_Services('GetColumnWidths', objLog)

Comments:
Returns the column widths that should be used to truncate or pad each column in the log.

Returns:
See comments.

GetQuoteValues

Usage:
Logging_Services('GetQuoteValues', objLog)

Comments:
Returns the flag to indicate whether column values should be quoted or not.

Returns:
See comments.

CreateLogFile

Usage:
Logging_Services('CreateLogFile', objLog)

Comments:
Creates (or clears out) a log file associated with the indicated log object handle.

Returns:
N/A

Params

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



  • No labels