RtdbgGetBasicCategoryName

RtdbgGetBasicCategoryName gets the display name of a message category.

Syntax

Copy

DWORD RtdbgGetBasicCategoryName(
  [in]    ULONG Category,
  [out]   wchar_t* pName
);

Parameters

[in] Category

The index of the category to configure. This value is between 0 and 63.

[out] pName

The buffer for the name. The buffer should be at least 64 characters long.

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 Category is outside the acceptable range (0-63). The value of parameter pName is NULL.

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:

Remarks

The RtdbgGetBasicCategoryName function is deterministic.

Requirements

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