Soap.WSDLItems.TWSDLItems.GetSoapOutputHeaders

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function  GetSoapOutputHeaders(BindingName: IQualifiedName; const Operation: DOMString;
OverloadIndex: Integer; const MessageName: DOMString;
var SOAPVersion: TSOAPVersion; out ResultsWSDLItems: IWSDLItems): IHeaderInfoArray;

C++

IHeaderInfoArray __fastcall GetSoapOutputHeaders(_di_IQualifiedName BindingName, const System::UnicodeString Operation, int OverloadIndex, const System::UnicodeString MessageName, Soap::Wsdlintf::TSOAPVersion &SOAPVersion, /* out */ _di_IWSDLItems &ResultsWSDLItems);

Properties

Type Visibility Source Unit Parent
function public
Soap.WSDLItems.pas
Soap.WSDLItems.hpp
Soap.WSDLItems TWSDLItems

Description

Returns an interface for accessing the header nodes that belong to the output node of a specified binding and operation.

Call GetSoapOutputHeaders to retrieve a dynamic array of interfaces for accessing the header nodes of the output node on a specified binding. GetSoapOutputHeaders locates the specified output node using the GetSoapBindingIONode method, and extracts all of its child header nodes. It then checks the message and part attributes of that output node, and returns a dynamic array of interfaces for the headers.

BindingName is an interface for reading the name of the binding that includes the <soap:binding> tag. A binding describes the encoding and transport protocols for an associated port type.

Operation is the name of the operation of that <soap:binding> tag. Operations correspond to methods on an invokable interface.

OverloadIndex indicates which operation node is desired when the binding has multiple operations with the same name (overloaded methods). 0 indicates the first operation with the specified name, 1 indicates the second operation node, and so on.

MessageName is the name of a Message with which the header should be associated. If MessageName is an empty string, GetSoapOutputHeaders does not check the message with which the header is associated.

If GetSoapOutputHeaders is unable to locate an output header node for the specified binding and operation, it returns nil (Delphi) or NULL (C++).

See Also