| NORSYS SOFTWARE © 2007 | NETICA API | C VERSION 3.25

const char* GetNodeStateComment_bn ( | const node_bn* node, state_bn state )

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

There is no restriction on the length of the comment, or on what characters it might contain. node may have some states commented, 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 2.26 and later have this function.

See also:

SetNodeStateComment_bn |  | Sets it
GetNodeStateTitle_bn |  | Gets the state's title
GetNodeNumberStates_bn |  | state must be between 0 and one less than this, inclusive