NxLib API > C Interface > Other > nxLibGetDebugMessages

Retrieves debug messages. This can also be done remotely from NxLibRemote.

Note: By calling this function the debug buffer will be fully cleared and the debug information can no longer be retrieved with nxLibGetDebugBuffer.

Note: Calling this function will temporarily lock all debug ring buffers and thus block all NxLib threads which are trying to push debug information onto their buffer. The user should therefore choose a point in time when NxLib is not performing time critical computations for his application to retrieve debug information.

Signatures

Variants throwing exceptions on errors:

static std::string nxLibGetDebugMessages()

Variants returning error codes in an int* parameter:

NXLIBSTR nxLibGetDebugMessages(NXLIBERR* result)

Parameters

result

The error code of the operation. If the message buffer could not hold all streamed messages, the error code NxLibDebugMessageOverflow will be returned. In that case, the returned string will contain only the newest debug messages that could fit into the buffer.

Return Value

The debug messages from all threads separated by the newline character (\n).