RtdbgGetBasicMessage

RtdbgGetBasicMessage gets the first Basic message in the queue.

Syntax

Copy

DWORD RtdbgGetBasicMessage(
  [out]   RTDBG_BASIC_MESSAGE_HEADER pHeader,
  [in]    ULONG MessageBufferLength,
  [out]   wchar_t* pMessage
);

Parameters

[out] pHeader

The pointer of the message header described in RTDBG_BASIC_MESSAGE_HEADER.

[in] MessageBufferLength

The size of the message buffer in WORDs.

[out] pMessage

The buffer of the message text in Unicode characters. The maximum length is 128 characters.

Return Values

Error code	Meaning
ERROR_SUCCESS	The function succeeded.
ERROR_NOT_READY	The calling process hasn't called RtdbgOpenBasicChannel.
ERROR_INVALID_PARAMETER	One of the following conditions occurred: The value of parameter pHeader is NULL. The value of parameter MessageBufferLength is above 0 and parameter pMessage is NULL.
ERROR_NO_DATA	No message in the queue.

Remarks

The RtdbgGetBasicMessage function is deterministic.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtdbgApi.h	RtdbgApi_W64.lib (Windows), RtdbgApi.lib (RTSS)