RtdbgSetBasicCategoryName

RtdbgSetBasicCategoryName sets the display name for a message category.

Syntax

Copy 
DWORD RtdbgSetBasicCategoryName(
  [in]    ULONG Category,
  [in]    wchar_t* pName
);

Parameters

[in] Category

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

[in] pName

The display name of this message category in Unicode characters. The maximum length is 64 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 Category is outside the acceptable range (0-63).
  • The value of parameter pName is either NULL or contains more than 64 characters.

Remarks

The RtdbgSetBasicCategoryName function is deterministic.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtdbgApi.h

RtdbgApi_W64.lib (Windows), RtdbgApi.lib (RTSS)

See Also: