Logging Event Data Access

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

Functions
SPINNAKERC_API	spinLogDataGetCategoryName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the category name of a log event. More...
SPINNAKERC_API	spinLogDataGetPriority (spinLogEventData hLogEventData, int64_t *pValue)
	Retrieves the priority of a log event. More...
SPINNAKERC_API	spinLogDataGetPriorityName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the priority name of a log event. More...
SPINNAKERC_API	spinLogDataGetTimestamp (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the timestamp of a log event. More...
SPINNAKERC_API	spinLogDataGetNDC (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the NDC of a log event. More...
SPINNAKERC_API	spinLogDataGetThreadName (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the thread name of a log event. More...
SPINNAKERC_API	spinLogDataGetLogMessage (spinLogEventData hLogEventData, char *pBuf, size_t *pBufLen)
	Retrieves the log message of a log event. More...

Detailed Description

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

Function Documentation

spinLogDataGetCategoryName()

SPINNAKERC_API 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

spinLogDataGetLogMessage()

SPINNAKERC_API 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

spinLogDataGetNDC()

SPINNAKERC_API 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

spinLogDataGetPriority()

SPINNAKERC_API 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

spinLogDataGetPriorityName()

SPINNAKERC_API 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

spinLogDataGetThreadName()

SPINNAKERC_API 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

spinLogDataGetTimestamp()

SPINNAKERC_API 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