SOAPPrepare (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SOAPPrepare (Function)

In french: SOAPPrepare

Builds the SOAP request for calling a Webservice function.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 22 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

New in version 22

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

Versions 25 and later

This function is now available for Android applications.

New in version 25

This function is now available for Android applications.

Example

// Standard call that is using the full call to a WebService method
stParam1 is Param1
stParam1.String = "a string"
stParam1.Int = 2
stRet is Result1
stRet = MyFunction(stParam1)

// Equivalent call defining the buffer
// and using SOAPRunXML
stParam1 is Param1
stParam1.String = "a string"
stParam1.Int = 2
byBuffer is Buffer = SOAPPrepare(MyFunction, stParam1)
SOAPExécuteXML("http://localhost/webService/", byBuffer, "MyFunction")

Syntax

<Result> = SOAPPrepare(<Function name> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Buffer

XML buffer containing the generated SOAP request.

<Function name>: Character string

Webservice function for which the SOAP request must be built.

<Parameter 1>: Variant

First parameter of the Webservice function.

<Parameter N>: Variant

Nth parameter of Webservice function.

Remarks

SOAPPrepare SOAPPrepare builds the SOAP request that would be sent to the Webservice during a call to one of its functions without running the request.

Then, the generated buffer can be sent by SOAPRunXML.

The returned buffer contains the XML stream encoded in UTF8. The buffer does not contain the HTTP header (indicating the SOAP Action, the content-type, etc.). The headers are automatically added by SOAPRunXML.

Business / UI classification: Business Logic

Component: wd270xml.dll