RtGenerateEvent
RtGenerateEvent generates custom Monitoring events.
Syntax
BOOL RtGenerateEvent( unsigned int kind, void * buffer, size_t size );
Parameters
kind
A user-selected unique identifier for the custom event.
buffer
Must point to a memory region (no larger than 500 bytes) containing the custom event data.
size
The size of the buffer.
Return Value
Returns TRUE if the function succeeds, otherwise it returns FALSE.
Remarks
If RtGenerateEvent fails, call GetLastError to obtain an error code. The possible errors are as follows:
- ERROR_INVALID_PARAMETER - Parameter "buffer" is NULL or parameter "size" is greater than 500.
- ERROR_BUFFER_OVERFLOW - The internal buffer used to transport monitor data from the RTSS processors to the Windows processors are full. Over time, more space will become available in the buffer.
- ERROR_INVALID_FUNCTION - An internal consistency check has failed.
Requirements
Minimum Supported Version | RTX64 2014 |
Header | Rtapi.h |
Library | RtApi.lib (Windows), Rtx_Rtss.lib (RTSS) |
See Also: