IMapContainer.GetMap Method

Solclient

IMapContainerGetMap Method

version: 7.2.1.27

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)

Syntax

C++

Copy

IMapContainer 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: IMapContainer
Map 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.

Reference

IMapContainer Interface

SolaceSystems.Solclient.Messaging.SDT Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page