const char* GetNodeStateTitle_bn ( const node_bn*  node,   state_bn  state )

Given an integer index representing a state of node, this returns the associated title of that state, or the empty string (rather than NULL) if it does not have a title.

This may be different from state's "name" (see GetNodeStateName_bn).

There is no restriction on the length of the title, or on what characters it might contain. node may have some states titled, and others not.

If you need the string to persist, make a copy of the string returned, since its contents may become invalid after further calls to Netica API. Do not try to directly modify or free the string returned.

Version:

Versions 1.18 and later have this function.

See also:

SetNodeStateTitle_bn    Sets it
GetNodeStateName_bn    Returns the state's restricted name
GetNodeStateComment_bn    Returns the state's comment
GetNodeNumberStates_bn    state must be between 0 and one less than this, inclusive