Soap.InvokeRegistry.IntfHeaderItem

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

  IntfHeaderItem = record
    Info: PTypeInfo;
    ClassType: TClass;
    Namespace: InvString;                   { Header namespace }
    Name: InvString;                        { Header name }
    DefaultMethodType: eHeaderMethodType;   { used if MethodNames = '' }
    DefaultRequired: Boolean;               { used if MethodNames = '' }
    MethodNames: string;                    { comma-delimited list of Method Names }
    MethodTypes: THeaderMethodTypeArray;    { matching array of in/out/inout enums }
    HeaderRequired: TRequiredArray;         { matching array of Required Booleans }
  end;

C++

struct DECLSPEC_DRECORD IntfHeaderItem
{
public:
    System::Typinfo::TTypeInfo *Info;
    System::TClass ClassType;
    System::UnicodeString Namespace;
    System::UnicodeString Name;
    eHeaderMethodType DefaultMethodType;
    bool DefaultRequired;
    System::UnicodeString MethodNames;
    THeaderMethodTypeArray MethodTypes;
    TRequiredArray HeaderRequired;
};

Properties

Type Visibility Source Unit Parent
record
struct
public
Soap.InvokeRegistry.pas
Soap.InvokeRegistry.hpp
Soap.InvokeRegistry Soap.InvokeRegistry

Description

IntfHeaderItem and THeaderItemArray describe the association between a header and the SOAP messages that include it.

IntfHeaderItem describes a single header type. THeaderItemArray is an array of IntfHeaderItem descriptors. Typically, this array describes the set of headers associated with an invokable interface.

Info is a pointer to the type description for the interface that the header is associated with.

ClassType is the class reference for the header class (a TSOAPHeader descendant).

NameSpace is the namespace in which the header's name is defined.

Name is the name of the header node.

DefaultMethodType indicates whether the header is included in request messages, response messages, or both. This value is only used if the MethodNames field is an empty string. If MethodNames is nonempty, use the MethodTypes field instead.

DefaultRequired indicates whether the header must appear in messages about the interface that Info describes. If DefaultRequired is false, the header is optional. This value is only used if the MethodNames field is an empty string. If MethodNames is nonempty, use the HeaderRequired field instead.

MethodNames is a comma-delimited list of method names. If empty, the header is associated with all methods on the interface. If MethodNames includes one or more names, the header is only associated with those methods of the interface that are contained in the list.

MethodTypes is a dynamic array of values that indicate whether the header is included in request messages, response messages, or both. Each value is associated with a method listed in the MethodNames field in the same position. If MethodNames is an empty string, MethodTypes is not used.

HeaderRequired is a dynamic array of values that indicate whether the header is required or optional. Each value is associated with a method listed in the MethodNames field in the same position. If MethodNames is an empty string, HeaderRequired is not used.