GetComment Method (XDATA)


9.8A

 

The GetComment method returns the comment string value for a DOM_COMMENT_NODE node. The method uses the following format:

 

[label]

{object}.GetComment

[GIVING {return}]

Where:

label
Optional. A Program Execution Label.
object
Required. An XDATA object.
return
Optional. A Character String Variable that receives the string value for a DOM_COMMENT_NODE node.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The ZERO and OVER flags are set FALSE.

  2. The EOS flag is set TRUE if the comment string value must be truncated to be stored into the {return} variable.

  3. If the comment string exists, the {return} contains the string data. Otherwise, the {return} variable is set NULL..

 

 

See Also: XDATA, XDATA Methods, Method Syntax



PL/B Language Reference FindNode Method (XDATA) GetData Method (XDATA)