SOAPGetHeader (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Communication / SOAP

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SOAPGetHeader (Function)

In french: SOAPRécupèreEntête

Retrieves a header in the SOAP message received further to a call to a web service.

Example

// Call the function for sending SMSs of the WSSMS web service (fictitious) 
WebServiceSendSMS("0601020304", "ALERT", ...
	"Warning: the database server is no longer responding").

// Retrieve the number of remaining credits
// This number is returned by the WSSMS web service in the headers of the SOAP requests
RemainingCredit is int 
RemainingCredit = SOAPGetHeader(WSSMS, "NumberCredits")
IF RemainingCredit < 50 THEN
	WarnEndCredit()
END

Syntax

<Result> = SOAPGetHeader(<Webservice> , <Header>)

<Result>: Variable whose type depends on the header

Value of retrieved header. If the requested header does not exist, the ErrorOccurred variable is set to True.
The type of the returned value depends on the requested header. This type is specified in the documentation of the web service.

<Webservice>: Character string

Name of the web service to use.

<Header>: Character string

Name of the header to retrieve.

Remarks

SOAPGetHeader must be called:

after running a function of the web service,
before any other call to a function of the web service or to SOAPRun or SOAPRunXML.

SOAPGetHeader can be called multiple times to retrieve multiple headers.

Business / UI classification: Business Logic

Component: wd300xml.dll