IROBinMessage

 

Sets SOAP attributes (SOAP message only)

procedure ApplyAttributes2

---

Sets transport related attributes (SOAP message only)

procedure ApplyAttributes2_Transport(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Provides access to the ClientID read from the message. See event dispatching for a usage example.

property ClientID: TGUID read write

---

Size of the buffer used for compression (default is 256 kilobytes).

Increasing the buffer increases compression performance for large messages, but it also increases memory footprint. The best performance is reached with a buffer that's large enough for the maximum expected message size.

property CompressionBufferSize: Integer read write

---

Ensures that the message content is complete before sending it by performing all necessary final processing. This method is called after all parameters have been written to a message and before the message will be sent. It should perform all necessary wrap-up to ensure that a subsequent call to WriteToStream will produce a complete message.

procedure Finalize

---

Destroys stream

procedure FreeStream

---

Envelopes collection.

function GetEnvelopes: TCollection

---

Initializes the message with the given parameters.

procedure Initialize(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string; aType: TMessageType)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name
• aType: Message type

---

Initializes the message with the given parameters.

procedure Initialize(const aTransport: IROTransport; const anInterfaceName: string; const aMessageName: string; aType: TMessageType)

Parameters:

• aTransport: IROTransport
• anInterfaceName: Interface name
• aMessageName: Message name
• aType: Message type

---

Initializes an Event message with the given parameters.

procedure InitializeEventMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Initializes an Exception message with the given parameters.

procedure InitializeExceptionMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Performs additional initialization before reading.

procedure InitializeRead(const aTransport: IROTransport)

Parameters:

• aTransport: IROTransport

---

Initializes a mtRequest message with the given parameters.

procedure InitializeRequestMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Initializes a mtResponse message with the given parameters.

procedure InitializeResponseMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Contains the name of the interface or service that is to be or was called on the server.

property InterfaceName: string read write

---

property MaxEventsPerPoll: Integer read

---

Contains the name of the message (i.e. the method name) that is to be or was called on the server.

property MessageName: string read write

---

Type of the message represented by the message instance.

property MessageType: TMessageType read

---

Minimum size for a message before compression is applied (default is 4096 bytes). Messages below this threshold are sent uncompressed, as the overhead of compressing and decompressing the data would likely outweigh the gain of having an only slightly smaller packet on the network.

property MinSizeForCompression: Integer read write

---

The general method to read any data.

procedure Read(const aName: string; aTypeInfo: PTypeInfo; var Ptr: ; ExtraAttributes: TParamAttributes)

Parameters:

• aName: Name of the object to read.
• aTypeInfo: Runtime type information for the data to read.
• Ptr: Output parameter, should point to the deserialized instance.
• ExtraAttributes: Set of TParamAttribute

---

Reads an array value.

function ReadArray(const aName: string; aClass: TClass; var Ref: ; ArrayElementId: Integer): Boolean

Parameters:

• aName: Name of the object to read.
• aClass: Class of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Binary value.

procedure ReadBinary(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a TDateTime value.

procedure ReadDateTime(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Decimal value.

procedure ReadDecimal(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Double value.

procedure ReadDouble(const aName: string; aFloatType: TFloatType; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• aFloatType: Specifies the exact floating point type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads an enumerated value.

procedure ReadEnumerated(const aName: string; anEnumTypeInfo: PTypeInfo; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• anEnumTypeInfo: Runtime type information for the enuymerated type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadFromStream(Source: TStream)

Parameters:

• Source: stream

---

Writes the content of the message to aStream.

procedure ReadFromStream(Source: TStream; var aFreeStream: Boolean)

Parameters:

• Source: stream
• aFreeStream: free stream

---

Reads a GUID value.

procedure ReadGuid(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Int64 value.

procedure ReadInt64(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Integer value (32 bits or less).

procedure ReadInteger(const aName: string; anOrdType: TOrdType; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• anOrdType: Specifies the exact integer point type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadLegacyString(const aName: string; var Ref: ; ExtraAttributes: TParamAttributes; ArrayElementId: Integer; aMaxLength: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ExtraAttributes: specified what string should be read (AnsiString or UTF8String)
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.
• aMaxLength: Specifies the maximum string length to read, is set to -1 when no restriction is required.

---

Reads a Struct value.

function ReadStruct(const aName: string; aClass: TClass; var Ref: ; ArrayElementId: Integer): Boolean

Parameters:

• aName: Name of the object to read.
• aClass: Class of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadUnicodeString(const aName: string; var Ref: ; ArrayElementId: Integer; aMaxLength: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.
• aMaxLength: Specifies the maximum string length to read, is set to -1 when no restriction is required.

---

Reads a Variant value.

procedure ReadVariant(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a XML value.

procedure ReadXml(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Sets additional information.

procedure SetAttributes(aTransport: IROTransport; const aNames: array of string; const aValues: array of string)

Parameters:

• aTransport: Transport channel
• aNames:
• aValues:

---

procedure SetAutoGeneratedNamespaces(aValue: string)

Parameters:

• aValue:

---

procedure SetDefaultNamespaces(aValue: string)

Parameters:

• aValue:

---

stores SOAP attributes (SOAP message only)

procedure StoreAttributes2(const aNames: array of string; const aValues: array of string)

Parameters:

• aNames:
• aValues:

---

Stream

property Stream: TStream read

---

Clears additional information.

procedure UnsetAttributes(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Clears additional information.

procedure UnsetAttributes2

---

Clears additional information.

procedure UnsetAttributes2_Transport(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Toggles whether outgoing messages will be automatically compressed if they exceed a specific size.

property UseCompression: Boolean read write

---

Indicates when a message was compressed.

property WasCompressed: Boolean read

---

Writes the value of the aName parameter from Ptr with the given aTypeInfo and ExtraAttributes to the message.

procedure Write(const aName: string; aTypeInfo: PTypeInfo; const Ptr: ; ExtraAttributes: TParamAttributes)

Parameters:

• aName: Name of the object to write.
• aTypeInfo: RTI
• Ptr: Pointer to the source variable
• ExtraAttributes: set of TParamAttribute

---

Writes an array value.

procedure WriteArray(const aName: string; const Ref: ; aClass: TClass; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• aClass: Class of the object to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Binary value.

procedure WriteBinary(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a TDateTime value.

procedure WriteDateTime(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Decimal value.

procedure WriteDecimal(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Double value.

procedure WriteDouble(const aName: string; aFloatType: TFloatType; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• aFloatType: Specifies the exact floating point data type to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes an enumerated value.

procedure WriteEnumerated(const aName: string; anEnumTypeInfo: PTypeInfo; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• anEnumTypeInfo: Runtime type information of the enumerated type.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure WriteException(Dest: TStream; anException: Exception)

Parameters:

• Dest: stream
• anException: free stream

---

Writes a GUID value.

procedure WriteGuid(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Int64 value.

procedure WriteInt64(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Integer value (32 bits or less).

procedure WriteInteger(const aName: string; anOrdType: TOrdType; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• anOrdType: Specifies the exact integer data type to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a legacy string (AnsiString or UTF8String) value.

procedure WriteLegacyString(const aName: string; const Ref: ; ExtraAttributes: TParamAttributes; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ExtraAttributes: specified what string should be written (AnsiString or UTF8String)
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Struct value.

procedure WriteStruct(const aName: string; const Ref: ; aClass: TClass; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• aClass: Class of the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure WriteToStream(Dest: TStream)

Parameters:

• Dest: stream

---

Writes a WideString value.

procedure WriteUnicodeString(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Variant value to the message.

procedure WriteVariant(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a XML value.

procedure WriteXml(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

 

Provides access to the ClientID read from the message. See event dispatching for a usage example.

property ClientID: TGUID read write

---

Size of the buffer used for compression (default is 256 kilobytes).

Increasing the buffer increases compression performance for large messages, but it also increases memory footprint. The best performance is reached with a buffer that's large enough for the maximum expected message size.

property CompressionBufferSize: Integer read write

---

Contains the name of the interface or service that is to be or was called on the server.

property InterfaceName: string read write

---

property MaxEventsPerPoll: Integer read

---

Contains the name of the message (i.e. the method name) that is to be or was called on the server.

property MessageName: string read write

---

Type of the message represented by the message instance.

property MessageType: TMessageType read

---

Minimum size for a message before compression is applied (default is 4096 bytes). Messages below this threshold are sent uncompressed, as the overhead of compressing and decompressing the data would likely outweigh the gain of having an only slightly smaller packet on the network.

property MinSizeForCompression: Integer read write

---

Stream

property Stream: TStream read

---

Toggles whether outgoing messages will be automatically compressed if they exceed a specific size.

property UseCompression: Boolean read write

---

Indicates when a message was compressed.

property WasCompressed: Boolean read

 

Sets SOAP attributes (SOAP message only)

procedure ApplyAttributes2

---

Sets transport related attributes (SOAP message only)

procedure ApplyAttributes2_Transport(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Ensures that the message content is complete before sending it by performing all necessary final processing. This method is called after all parameters have been written to a message and before the message will be sent. It should perform all necessary wrap-up to ensure that a subsequent call to WriteToStream will produce a complete message.

procedure Finalize

---

Destroys stream

procedure FreeStream

---

Envelopes collection.

function GetEnvelopes: TCollection

---

Initializes the message with the given parameters.

procedure Initialize(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string; aType: TMessageType)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name
• aType: Message type

---

Initializes the message with the given parameters.

procedure Initialize(const aTransport: IROTransport; const anInterfaceName: string; const aMessageName: string; aType: TMessageType)

Parameters:

• aTransport: IROTransport
• anInterfaceName: Interface name
• aMessageName: Message name
• aType: Message type

---

Initializes an Event message with the given parameters.

procedure InitializeEventMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Initializes an Exception message with the given parameters.

procedure InitializeExceptionMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Performs additional initialization before reading.

procedure InitializeRead(const aTransport: IROTransport)

Parameters:

• aTransport: IROTransport

---

Initializes a mtRequest message with the given parameters.

procedure InitializeRequestMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

Initializes a mtResponse message with the given parameters.

procedure InitializeResponseMessage(const aTransport: IROTransport; const aLibraryName: string; const anInterfaceName: string; const aMessageName: string)

Parameters:

• aTransport: IROTransport
• aLibraryName: RODL file name
• anInterfaceName: Interface name
• aMessageName: Message name

---

The general method to read any data.

procedure Read(const aName: string; aTypeInfo: PTypeInfo; var Ptr: ; ExtraAttributes: TParamAttributes)

Parameters:

• aName: Name of the object to read.
• aTypeInfo: Runtime type information for the data to read.
• Ptr: Output parameter, should point to the deserialized instance.
• ExtraAttributes: Set of TParamAttribute

---

Reads an array value.

function ReadArray(const aName: string; aClass: TClass; var Ref: ; ArrayElementId: Integer): Boolean

Parameters:

• aName: Name of the object to read.
• aClass: Class of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Binary value.

procedure ReadBinary(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a TDateTime value.

procedure ReadDateTime(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Decimal value.

procedure ReadDecimal(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Double value.

procedure ReadDouble(const aName: string; aFloatType: TFloatType; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• aFloatType: Specifies the exact floating point type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads an enumerated value.

procedure ReadEnumerated(const aName: string; anEnumTypeInfo: PTypeInfo; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• anEnumTypeInfo: Runtime type information for the enuymerated type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadFromStream(Source: TStream)

Parameters:

• Source: stream

---

Writes the content of the message to aStream.

procedure ReadFromStream(Source: TStream; var aFreeStream: Boolean)

Parameters:

• Source: stream
• aFreeStream: free stream

---

Reads a GUID value.

procedure ReadGuid(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Int64 value.

procedure ReadInt64(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a Integer value (32 bits or less).

procedure ReadInteger(const aName: string; anOrdType: TOrdType; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• anOrdType: Specifies the exact integer point type to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadLegacyString(const aName: string; var Ref: ; ExtraAttributes: TParamAttributes; ArrayElementId: Integer; aMaxLength: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ExtraAttributes: specified what string should be read (AnsiString or UTF8String)
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.
• aMaxLength: Specifies the maximum string length to read, is set to -1 when no restriction is required.

---

Reads a Struct value.

function ReadStruct(const aName: string; aClass: TClass; var Ref: ; ArrayElementId: Integer): Boolean

Parameters:

• aName: Name of the object to read.
• aClass: Class of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure ReadUnicodeString(const aName: string; var Ref: ; ArrayElementId: Integer; aMaxLength: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.
• aMaxLength: Specifies the maximum string length to read, is set to -1 when no restriction is required.

---

Reads a Variant value.

procedure ReadVariant(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Reads a XML value.

procedure ReadXml(const aName: string; var Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to read.
• Ref: Output parameter, should point to the deserialized instance.
• ArrayElementId: If the object about to be read is an array element, its index is contained in this parameter, otherwise it is -1.

---

Sets additional information.

procedure SetAttributes(aTransport: IROTransport; const aNames: array of string; const aValues: array of string)

Parameters:

• aTransport: Transport channel
• aNames:
• aValues:

---

procedure SetAutoGeneratedNamespaces(aValue: string)

Parameters:

• aValue:

---

procedure SetDefaultNamespaces(aValue: string)

Parameters:

• aValue:

---

stores SOAP attributes (SOAP message only)

procedure StoreAttributes2(const aNames: array of string; const aValues: array of string)

Parameters:

• aNames:
• aValues:

---

Clears additional information.

procedure UnsetAttributes(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Clears additional information.

procedure UnsetAttributes2

---

Clears additional information.

procedure UnsetAttributes2_Transport(aTransport: IROTransport)

Parameters:

• aTransport: Transport channel

---

Writes the value of the aName parameter from Ptr with the given aTypeInfo and ExtraAttributes to the message.

procedure Write(const aName: string; aTypeInfo: PTypeInfo; const Ptr: ; ExtraAttributes: TParamAttributes)

Parameters:

• aName: Name of the object to write.
• aTypeInfo: RTI
• Ptr: Pointer to the source variable
• ExtraAttributes: set of TParamAttribute

---

Writes an array value.

procedure WriteArray(const aName: string; const Ref: ; aClass: TClass; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• aClass: Class of the object to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Binary value.

procedure WriteBinary(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a TDateTime value.

procedure WriteDateTime(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Decimal value.

procedure WriteDecimal(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Double value.

procedure WriteDouble(const aName: string; aFloatType: TFloatType; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• aFloatType: Specifies the exact floating point data type to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes an enumerated value.

procedure WriteEnumerated(const aName: string; anEnumTypeInfo: PTypeInfo; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• anEnumTypeInfo: Runtime type information of the enumerated type.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure WriteException(Dest: TStream; anException: Exception)

Parameters:

• Dest: stream
• anException: free stream

---

Writes a GUID value.

procedure WriteGuid(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Int64 value.

procedure WriteInt64(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Integer value (32 bits or less).

procedure WriteInteger(const aName: string; anOrdType: TOrdType; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• anOrdType: Specifies the exact integer data type to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a legacy string (AnsiString or UTF8String) value.

procedure WriteLegacyString(const aName: string; const Ref: ; ExtraAttributes: TParamAttributes; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ExtraAttributes: specified what string should be written (AnsiString or UTF8String)
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Struct value.

procedure WriteStruct(const aName: string; const Ref: ; aClass: TClass; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• aClass: Class of the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes the content of the message to aStream.

procedure WriteToStream(Dest: TStream)

Parameters:

• Dest: stream

---

Writes a WideString value.

procedure WriteUnicodeString(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a Variant value to the message.

procedure WriteVariant(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.

---

Writes a XML value.

procedure WriteXml(const aName: string; const Ref: ; ArrayElementId: Integer)

Parameters:

• aName: Name of the object to write.
• Ref: Points to the instance to serialize.
• ArrayElementId: If the object to write is an array element, its index is contained in this parameter, otherwise it is -1.