Soap.InvokeRegistry.TRemotableTypeRegistry.ClassOptions

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function  ClassOptions(AClass: TClass): TObjMultiOptions;

C++

TObjMultiOptions __fastcall ClassOptions(System::TClass AClass);

Properties

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

Description

Indicates how to handle multiple references to the same object when converting a specified remotable class to its SOAP representation.

When an application converts a remotable class to its SOAP representation, it can convert multiple references to the same object in one of two ways. It can treat the object as if its properties have meaning, but not the reference itself. (That is, two references to the same object are equivalent values, but not the same thing.) Alternately, if the object reference itself has meaning, it can encode the fact that these are multiple references to the same entity in the SOAP packet.

Individual remotable classes can specify how they want this conversion to be handled, overriding any defaults that would otherwise be used. For example, THTTPRIO, THTTPSoapPascalInvoker, and THTTPSoapCppInvoker use TOPToSoapDomConvert to convert between remotable classes and their SOAP representation. TOPToSoapDomConvert has an Options property that specifies, among other things, whether to encode multiple references to the same object by value or as references. Individual remotable classes can supply an override to this default strategy when they are registered using the RegisterXSClass method.

ClassOptions returns how to handle multiple references of a specified class.

AClass is a class reference for the registered class that you want to know how to convert.

See Also