DiMgslPutTraceEvent

Prototype
`NTSTATUS DiMgslPutTraceEvent( void *Handle, ULONG EventType, USHORT Size, PVOID Data );`
Parameters
`Handle`	handle to open port
`EventType`	type of event
`Size`	number of bytes passed via the Data pointer
`Data`	pointer to application trace data
Return Value
`STATUS_SUCCESS`	trace event added to trace buffers
`STATUS_INVALID_HANDLE`	Handle is invalid
`STATUS_INVALID_PARAMETER`	TraceEvent is invalid.

Add a trace event to the API trace buffers. This allows the caller to define application specific trace events and add them to the trace buffers. These events will be extracted from the trace buffers with DiMgslGetTraceEvent in the same way as API generated trace events. This is useful for debugging HDLC API applications. Application defined event types should be chosen to not conflict with the API generated event types as described in the tracing section.

On entry, the application must supply the trace event EventType, Size, and Data. The API will supply the TimeStamp field. The API will supply the TimeStamp field. Refer to the MGSL_TRACE_EVENT section for more information on the input trace parameters. The maximum EventData length is defined by the HDLC_MAX_FRAME_SIZE constant.

Contents