IMapContainer.GetField Method


IMapContainerGetField Method
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: (
ISDTField GetField(
	string name
Function GetField ( 
	name As String
) As ISDTField
ISDTField^ GetField(
	String^ name


Type: SystemString
The name of the field to get.

Return Value

Type: ISDTField
The field with the given name.
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.
See Also