OverView Index Help WebNMS Agent Toolkit C Edition 6

tl1log.c

Contains function definitions for logging implementation.

Return Type	Method Summary
CHAR	`AddTL1LogRecord(CHAR* logName, CHAR opCategory, CHAR *data)` creating and adding a new record for a given logname.
CHAR	`CheckLogDurExpiry(LogEntry * logEntryPtr)` check logduration specified.
CHAR	`CreateAndAddNewLogEntry(CHAR logName, U_CHAR status, CHAR logduration, CHAR *opCategoryList, INT32 maxMsg)`
CHAR	`FreeLogEntry(LogEntry * logEntryPtr)` Free all the given log's entries.
CHAR	`FreeallLogEntry()` Free all the log entries.
void	`InitialiseLog(void * logname)` Clear log if logname exists or create a new log entry.
void	`SetAllowLogging(void *logName)` set logging status to ALLOW.
void	`SetNoAllowLogging(void * logname)` Stop logging data.
CHAR	`WritetoLogFile(CHAR * logName)` write log details to file.

Method Details

AddTL1LogRecord()

CHAR AddTL1LogRecord(CHAR* logName,CHAR opCategory,CHAR *data)

creating and adding a new record for a given logname. This function logs the message in the specifed Log.

Arguments:

1. logName in which message is to be logged.

2. Operation category of the message to be logged.

3. Message to be logged.

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

CheckLogDurExpiry()

CHAR CheckLogDurExpiry(LogEntry * logEntryPtr)

check logduration specified.If over stop logging.

Arguments:

1. Reference to LogEntry (IN).

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

CreateAndAddNewLogEntry()

CHAR CreateAndAddNewLogEntry(CHAR *logName,U_CHAR status,CHAR *logduration,CHAR *opCategoryList,INT32 maxMsg)

creates a new log Entry

Arguments:

1. logName in which message is to be logged.

2. status (Allow/Not Allow Logging)

3. Duration of logging

4. List of operation categories allowed

5. Maximum number messages buffer can hold

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

FreeLogEntry()

CHAR FreeLogEntry(LogEntry * logEntryPtr)

Free all the given log's entries.

Arguments:

1. Reference to the logEntry(IN)

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

FreeallLogEntry()

CHAR FreeallLogEntry()

Free all the log entries.

Arguments:

Nothing

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

InitialiseLog()

void InitialiseLog(void * logname)

Clear log if logname exists or create a new log entry.

Arguments:

1. logname

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

SetAllowLogging()

void SetAllowLogging(void *logName)

set logging status to ALLOW.

Arguments:

1. logName.

Return type:

Nothing.

Bugs:

null

See Also:

SetNoAllowLogging()

void SetNoAllowLogging(void * logname)

Stop logging data.

Arguments:

1. logname.

Return type:

Nothing.

Bugs:

null

See Also:

WritetoLogFile()

CHAR WritetoLogFile(CHAR * logName)

write log details to file. (general method)

Arguments:

1. Logname.

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

OverView Index Help WebNMS Agent Toolkit C Edition 6