PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Running the procedure (syntax 3)
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Adds a header to the next SOAP function of a Webservice to run.
The added header can contain additional parameters affecting the SOAP request. In most cases, the information added into the headers does not directly represent the parameters of the Webservice function but meta information such as the authentication information for example.
Note: The SOAP function will be run by a call to SOAPRun or SOAPRunXML.
Versions 18 and later
Universal Windows 10 App This function is now available in Windows Store apps mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 18
Universal Windows 10 App This function is now available in Windows Store apps mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Universal Windows 10 App This function is now available in Windows Store apps mode.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Versions 22 and later
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
WINDEVLinux This function is now available for the WINDEV applications in Linux.
New in version 22
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
WINDEVLinux This function is now available for the WINDEV applications in Linux.
WEBDEV - Server codeLinux This function is now available for the WEBDEV sites in Linux.
WINDEVLinux This function is now available for the WINDEV applications in Linux.
Example
// Add a header to the next SOAP procedure run
// This header is used to check the security level used by the SOAP server
// If the maximum security level is not used,
// the next SOAP procedure will not be run
SOAPAddHeader("Security", "MaxSecurity", "Security-Level", True)
Syntax
Versions 18 and later

Customizing the header of the Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Element to Add into Header>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Element to Add into Header>: Simple or complex type
Variable of the same type as the header to insert into the call to the Webservice method. The different types have been retrieved when importing the WSDL file.
This element is added into the header whenever a SOAP function of the Webservice is called.
New in version 18

Customizing the header of the Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Element to Add into Header>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Element to Add into Header>: Simple or complex type
Variable of the same type as the header to insert into the call to the Webservice method. The different types have been retrieved when importing the WSDL file.
This element is added into the header whenever a SOAP function of the Webservice is called.

Customizing the header of the Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Element to Add into Header>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Element to Add into Header>: Simple or complex type
Variable of the same type as the header to insert into the call to the Webservice method. The different types have been retrieved when importing the WSDL file.
This element is added into the header whenever a SOAP function of the Webservice is called.
Versions 18 and later

Adding a header for a specific Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Parameter Name> , <Parameter Value> , <Parameter Namespace>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Parameter Name>: Character string (with quotes)
Name of additional parameter.
This additional parameter is used to check an information specific to the SOAP server.
This parameter is supplied in the documentation of the SOAP server and its functions.
<Parameter Value>: Any type
Value of additional parameter.
The possible values are supplied in the documentation of the SOAP server and its functions.
<Parameter Namespace>: Character string (with quotes)
Namespace of parameter.
This parameter is supplied in the documentation of the SOAP server and its functions.
New in version 18

Adding a header for a specific Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Parameter Name> , <Parameter Value> , <Parameter Namespace>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Parameter Name>: Character string (with quotes)
Name of additional parameter.
This additional parameter is used to check an information specific to the SOAP server.
This parameter is supplied in the documentation of the SOAP server and its functions.
<Parameter Value>: Any type
Value of additional parameter.
The possible values are supplied in the documentation of the SOAP server and its functions.
<Parameter Namespace>: Character string (with quotes)
Namespace of parameter.
This parameter is supplied in the documentation of the SOAP server and its functions.

Adding a header for a specific Webservice Hide the details

SOAPAddHeader(<Webservice Name> , <Parameter Name> , <Parameter Value> , <Parameter Namespace>)
<Webservice Name>: Webservice
Name of webservice to use. The Webservice name is displayed in the "Project explorer" pane, in the "Webservices" folder.
<Parameter Name>: Character string (with quotes)
Name of additional parameter.
This additional parameter is used to check an information specific to the SOAP server.
This parameter is supplied in the documentation of the SOAP server and its functions.
<Parameter Value>: Any type
Value of additional parameter.
The possible values are supplied in the documentation of the SOAP server and its functions.
<Parameter Namespace>: Character string (with quotes)
Namespace of parameter.
This parameter is supplied in the documentation of the SOAP server and its functions.

Adding a header (syntax kept for backward compatibility) Hide the details

SOAPAddHeader(<Parameter Name> , <Parameter Value> , <Parameter Namespace> [, <Procedure Execution>])
<Parameter Name>: Character string (with quotes)
Name of additional parameter.
This additional parameter is used to check an information specific to the SOAP server.
This parameter is supplied in the documentation of the SOAP server and its functions.
<Parameter Value>: Any type
Value of additional parameter.
The possible values are supplied in the documentation of the SOAP server and its functions.
<Parameter Namespace>: Character string (with quotes)
Namespace of parameter.
This parameter is supplied in the documentation of the SOAP server and its functions.
<Procedure Execution>: Optional boolean
  • True: the procedure must not be run if the SOAP server cannot process the header (mandatory header).
  • False: the header is ignored by the execution of the procedure (optional header).
Remarks

Running the procedure (syntax 3)

You have the ability to run (or not) the next SOAP procedure by adding a header. To do so, <Procedure Execution> must be initialized to True.
If <Procedure Execution> is initialized to True:
  • SOAPRun (or SOAPRunXML) returns True if the connection with the SOAP server was established, False otherwise.
  • If the connection with the SOAP server was established and if the SOAP server fulfills the conditions requested by the header, the procedure is run.
  • If the procedure was run, SOAPGetResult returns:
    • the result of the procedure if the procedure was successfully run,
    • an empty string ("") if the procedure failed.
  • If the procedure failed or if it was not run, SOAPError returns:
    • the "MustUnderstand" error code if the SOAP server does not fulfills the conditions requested by the header,
    • an error in the other cases.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230com.dll
Windows Mobile wp230com.dll
Linux wd230com.so
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment