IMapContainer Methods

Adds a bool field with the given name.

Adds a byte array field with the given name.

Adds a char field with the given name.

Adds a IDestination instance field with the given name.

Adds a double field with the given name.

Adds a float field with the given name.

Adds a Int16 field with the given name.

Adds a Int32 field with the given name.

Adds a Int64 field with the given name.

Adds a Int8 field with the given name.

Adds a null field with the given name.

Adds a ISDTContainer field with the given name to this map container.

Adds a ISmfMessage field with the given name.

Adds a string field with the given name.

Adds a UInt16 field with the given name.

Adds a UInt32 field with the given name.

Adds a UInt64 field with the given name.

Adds a UInt8 field with the given name.

Adds a IUnknownSDTField field with a given name.

An unknown field is by definition a valid SDT field, that's not known to the current version of the API.

Closes the ISDTContainer, making it unusable for read or write operations.

It is an error to invoke this method in the following cases (An OperationErrorException will be thrown):

The IMessage holding this container is already sent (after calling Send(IMessage)).

The ISDTContainer holding this container is already closed (after calling Close).

Creates a submap with the given name. The returned IMapContainer is ready for read and write operations. It is recommended to Close the IMapContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.

Creates a substream with the given name. The returned IStreamContainer is ready for read and write operations. It is recommended to Close the IStreamContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.

Deletes the named field from the map.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Gets the field with the given name as a boolean.

Gets the field with the given name as a byte array.

Gets the field with the given name as a Char.

Gets the field with the given name as a IDestination.

Gets the field with the given name as a double.

This method returns a field of the given name.

If the returned ISDTField is of type SDTFieldType.MAP or SDTFieldType.STREAM, it is recommended to Close the container when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed. Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container results in an OperationErrorException with ParamNullReference error subcode.

Gets the field with the given name as a float.

Gets the field with the given name as a Int16.

Gets the field with the given name as a Int32.

Gets the field with a given name as a Int64.

Gets the field with the given name as a Int8.(converted to Int16)

Opens the contained submap with the given name. The returned IMapContainer is ready for read/write operations. It is recommended to Close the IMapContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.

Gets the next KeyValuePair(where key is a String and value is a ISDTField). If the returned ISDTField is of type SDTFieldType.MAP or SDTFieldType.STREAM, it is recommended to close the container when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.

Gets the field with the given name as a null. This is a special accessor; any SDT type with the inclusion of map and stream can be read as null.

Gets the field with the given name as a ISmfMessage.

Opens the contained substream with the given name. The returned IStreamContainer is ready for read and write operations. It is recommended to Close the IStreamContainer when done. If it is not explicitly closed, the container is automatically closed when the associated parent container is closed or the associated message (if it is a message-dependent container) is disposed.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this container will result in an OperationErrorException with ParamNullReference error subcode.

Gets the field with the given name as a string.

Gets the field with the given name as a UInt16 (converted to Int32).

Gets the field with the given name as a UInt32 (converted to Int64).

Gets the field with the given name as a UInt64 (converted to Int64, therefore there could be loss of precision).

Gets the field with the given name as a Byte (UInt8).

When iterating through a container (map or stream), this method will return false when the end of the container is reached without advancing the read cursor. It will return true otherwise.

Rewinds the container. Normally when HasNext returns false, client applications must call Rewind if they want to reiterate over the container's fields.