IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

SOAPHeader Property

Contents of the optional SOAP header sent to the server.

Syntax

 soap.getSOAPHeader([callback])
 soap.setSOAPHeader( SOAPHeader, [callback])

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 getSOAPHeader([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 setSOAPHeader([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

This property is used only while building SOAP requests.

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0