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.

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 Webservice.

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.

Example

// Call the function for sending SMSs of the WSSMS Webservice (fictitious) WebServiceSendingSMS (, ...
"Caution: the database server does not respond anymore.")

// Retrieve the number of remaining credits
// This number is returned by the WSSMS Webservice 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 Webservice.

<Webservice>: Character string (with or without quotes)

Name of the Webservice to use.

<Header>: Character string (with quotes)

Name of the header to retrieve.

Remarks

SOAPGetHeader must be called:

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

SOAPGetHeader can be called several times in order to retrieve several headers.

Business / UI classification : Business Logic

Component : wd260xml.dll