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

void SetNodeComment_bn ( | node_bn* node, const char* comment )

This associates the null terminated C character string comment with node to help document it.

The comment may contain anything, but is usually used to store such things as information on the variable represented by the node, its real-world significance, the meaning of its states, how the relation with its parents was determined, notes for future changes, etc. It is best if the comment consists only of that sort of descriptive information (and as ascii characters), in order to meet expectations in case you share this net with other people or Netica Application. If you wish to attach other data, use SetNodeUserField_bn.

Information that pertains to the net as a whole should not be placed here, but rather in the net's comment field.

To remove a node's comment, pass NULL or the empty string for comment.

Netica will make a copy of comment; it won't modify or free the passed string.

Version:

This function is available in all versions.

See also:

GetNodeComment_bn |  | Retrieves value
SetNetComment_bn |  | Set a comment for the whole net
SetNodeUserField_bn |  | To attach other types of information, and have it saved to file with the net

Example:

    To add to an existing comment, see SetNetComment_bn.