Soap.InvokeRegistry.TInvokableClassRegistry.RegisterHeaderMethod

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure RegisterHeaderMethod(Info: PTypeInfo; AClass: TClass;  const MethodName: string; MethodType: eHeaderMethodType = hmtAll; Required: Boolean = False); overload;

C++

void __fastcall RegisterHeaderMethod(System::Typinfo::PTypeInfo Info, System::TClass AClass, const System::UnicodeString MethodName, eHeaderMethodType MethodType = (eHeaderMethodType)(0x0), bool Required = false)/* overload */;

Properties

Type Visibility Source Unit Parent
procedure
function
public
Soap.InvokeRegistry.pas
Soap.InvokeRegistry.hpp
Soap.InvokeRegistry TInvokableClassRegistry

Description

Registers methods of an invokable interface that make use of a registered header.

Call RegisterHeaderMethod for each method of an invokable interface that uses a registered header type. The header class must be previously registered by a call to the RegisterHeaderClass method. If you do not call RegisterHeaderMethod, then the WSDL document for the interface treats the header as associated with all methods of the interface. Use RegisterHeaderMethod if you want to

Limit the use of the header to a subset of the methods.

Specify whether the header is used for request messages, response messages, or both in a way that varies from method to method.

Indicate that the header is required for some methods but not others.

Call RegisterHeaderMethod for each method that uses the header. After the first method is registered this way, the header becomes limited to that method alone (and to any method subsequently registered by another call to RegisterHeaderMethod).

Info points to the type information of the invokable interface that the header should accompany.

AClass describes the TSOAPHeader descendant that represents the header. This class must be previously registered by a call to RegisterHeaderClass.

MethodName is the name of a method that uses the header.

MethodType indicates whether the header is to be used on request messages, response messages, or both.

Required indicates whether the header must be included in messages about the specified method. When Required is true, the header must be included and understood by the recipient of the message. When Required is false, the header is optional.

See Also