IMapContainer.GetField Method

Solclient

previous page next page

Solclient

IMapContainerGetField Method

version: 7.2.1.27

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.

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

ISDTField GetField(
	string name
)

Function GetField ( 
	name As String
) As ISDTField

ISDTField^ GetField(
	String^ name
)

Parameters

name: Type: SystemString
The name of the field to get.

Return Value

Type: ISDTField
The field with the given name.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when input parameter is null.
InvalidOperationException	Thrown when the container is already closed.
OperationErrorException	Thrown when an error occurs. In this case ReturnCode and SDKErrorInfoare accessible from OperationErrorException and contain more information.
FieldNotFoundException	Thrown when no field exists with the given name.
FatalErrorException	Thrown when an unrecoverable error occurs.

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