BasicChannel.SetCategoryName Method

This method sets the text for a category.

Namespace: IntervalZero.MaxRT.Libraries.DebugMessage
Assembly: IntervalZero.MaxRT.Libraries (in IntervalZero.MaxRT.Libraries.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy

public void SetCategoryName(
    uint Category,
    string Name
)

Parameters

Category

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

Name

Type: String
The display name of this message category in Unicode characters. The maximum length is 64 characters.

Return Value

Type: void

InvalidOperationException is thrown when the channel is not open.

ArgumentNullException is thrown when parameter Name is null.

ArgumentException is thrown when parameter Name is empty.

MaxRTNativeException is thrown when these errors occur:

Error code	Meaning
ERROR_INVALID_PARAMETER	The value of parameter Category is outside the acceptable range (0-63).