ValueFormat Property

Format of data returned or set.

Syntax

 soap.getValueFormat([callback])
 soap.setValueFormat( valueFormat, [callback])

Possible Values

  0 (vfText), 
  1 (vfXML), 
  2 (vfFullXML)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getValueFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setValueFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The ValueFormat property specifies the format of the data set or received into/from value properties such as XText, ReturnValue, and the Params properties.

The following are the possible values:


vfText (0)	Textual data. Any '<', '>', and '&' characters are escaped to '<', '>', and '&'.
vfXML (1)	XML data, not including the enclosing element tags. No escaping is performed for the XML data, but element data (such as element attributes) will be escaped.
vfFullXML (2)	Same as vfXML, but including the enclosing element. No escaping is performed for both the XML data and the XML element.

Data Type

Integer