UpdateNode Method (XDATA)

9.8A

The UpdateNode method updates the current node using the specified parameters. Any keyword parameters not specified remain unchanged. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An XDATA object.

return

Optional. A Numeric Variable that receives a value to signify a pass or fail condition for the method execution.

label

Optional. A Character String Variable or literal that specifies the label string value of the node.

text

Optional. A Character String Variable or literal that specifies the text string value of the node.

jsontype

Optional. A Numeric Variable or decimal number that specifies the a jsontype value used when outputing a document for JSON. See the CreateElement XDATA method for details.

name

Optional. A Character String Variable or literal that specifies the name string value of the node represented as %name% as described in the CreateDocType XDATA method.

sysid

Optional. A Character String Variable or literal that specifies the sysid string value of the node represented as %sysid% as described in the CreateDocType XDATA method.

pubid

Optional. A Character String Variable or literal that specifies the pubid string value of the node represented as %pubid% as described in the CreateDocType XDATA method.

comment

Optional. A Character String Variable or literal that specifies the comment string value of the node.

target

Optional. A Character String Variable or literal that specifies the target string value of the node. The {target} string value replaces the %target% field in the PI. See the CreatePI XDATA method for details.

data

Optional. A Character String Variable or literal that specifies the data string value of the node. The {data} string value replaces the %target% field in the PI. See the CreatePI XDATA method for details.

Flags Affected:

Note the following:

1. The ZERO flag is set if the {return} value is zero.

2. The OVER flag is set TRUE if the {return} variable is too small where the returned value is truncated.

3. The EOS flag is always cleared.

4. The {return} value is a zero if the method execution is successful. Otherwise, a non-zero value is returned to indicate an error has occurred. See the XDATA Method Return Values for more details.

5. This method can return these values:

 

Value	Error
0	XDATA_ERR_NONE (Success)
5	XDATA_ERR_INVALID_UPDATE_DATA
6	XDATA_ERR_NO_CURRENT_POSITION
7	XDATA_ERR_DOCUMENT_POSITION-

See Also: XDATA, XDATA Methods, Method Syntax