Soap.InvokeRegistry.ISOAPHeaders

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

ISOAPHeaders = interface

C++

__interface  INTERFACE_UUID("{E240BE0C-256F-D611-96FA-00C04FA06B45}") ISOAPHeaders  : public System::IInterface

Properties

Type Visibility Source Unit Parent
interface
class
public
Soap.InvokeRegistry.pas
Soap.InvokeRegistry.hpp
Soap.InvokeRegistry Soap.InvokeRegistry

Description

ISOAPHeaders is the interface for accessing the headers that accompany a message encoded using SOAP.

ISOAPHeaders is the interface for accessing the headers of a SOAP envelope. It defines methods for adding headers that are sent with an outgoing message and for retrieving the headers that were included in an incoming message.

On the server, the implementation class for in invokable interface supports this interface. You can obtain a reference to the ISOAPHeaders interface from the implementation class (a TInvokableClass descendant). You can then use this interface to retrieve the headers that were included in an incoming request or to add headers to an outgoing response message. If your implementation class does not descend from TInvokableClass, you can obtain a reference to this interface using the global GetSOAPHeaders function.

For client-side header support, TRIO implements the ISOAPHeaders interface. However, you can't obtain an ISOAPHeaders interface directly from a remote interfaced object, because when you try to obtain an interface from TRIO or one of its descendants, it assumes that you are trying to obtain an invokable interface for a server object and generates an in-memory vtable. Instead, you must access the ISOAPHeaders interface from the invokable interface that the remote interface object supports.

Note: C++ method declarations that use ISOAPHeaders use the _di_ISOAPHeaders type instead. This type is a DelphiInterface wrapper around the ISOAPHeaders interface:

typedef System::DelphiInterface< ISOAPHeaders > _di_ISOAPHeaders;

See Also