Solclient
| IMapContainerGetMap Method |
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.
Namespace: SolaceSystems.Solclient.Messaging.SDT
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 7.2.1.27 (7.2.1.27)
SyntaxIMapContainer GetMap( string name )
Function GetMap ( name As String ) As IMapContainer
IMapContainer^ GetMap( String^ name )
Parameters
- name
- Type: SystemString
Field name; cannot be null.
Return Value
Type: IMapContainerMap field value
Exceptions| Exception | Condition |
|---|---|
| FieldNotFoundException | Thrown when no field with the given name exists. |
| OperationErrorException | Thrown when one of the following occurs: there is no such field with the given name or it is an invalid data conversion. In this case ReturnCode and SDKErrorInfo are accessible from OperationErrorException and contain more information. |
| FatalErrorException | Thrown when an unrecoverable error occurs. |
| InvalidOperationException | Thrown when the container is already closed. |
See Also