Group CLoggingEventData¶

The functions in this section allow for the retrieval of logging event data.

Public Functions¶

Type	Name
	spinLogDataGetCategoryName (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)
	spinLogDataGetLogMessage (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)
	spinLogDataGetNDC (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)
	spinLogDataGetPriority (spinLogEventData hLogEventData, int64_t * pValue)
	spinLogDataGetPriorityName (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)
	spinLogDataGetThreadName (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)
	spinLogDataGetTimestamp (spinLogEventData hLogEventData, char * pBuf, size_t * pBufLen)

Public Functions Documentation¶

function spinLogDataGetCategoryName¶

spinLogDataGetCategoryName (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the category name of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the category name of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetLogMessage¶

spinLogDataGetLogMessage (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the log message of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the log message of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetNDC¶

spinLogDataGetNDC (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the NDC of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the NDC of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetPriority¶

spinLogDataGetPriority (
    spinLogEventData hLogEventData,
    int64_t * pValue
)

Retrieves the priority of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pValue The integer pointer in which the priority value is returned

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetPriorityName¶

spinLogDataGetPriorityName (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the priority name of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the priority name of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetThreadName¶

spinLogDataGetThreadName (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the thread name of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the thread name of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinLogDataGetTimestamp¶

spinLogDataGetTimestamp (
    spinLogEventData hLogEventData,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the timestamp of a log event

See also: spinError

Parameters:

hLogEventData The log event data received from the log event
pBuf The c-string character buffer in which the timestamp of the log event is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error