SDTUtils.GetContainer Method

Solclient

SDTUtilsGetContainer Method

version: 7.2.1.27

Returns an ISDTContainer (if available) within a message. The ISDTContainer could be either a IMapContainer or IStreamContainer. It is recommended to Close the ISDTContainer when done. If it is not explicitly closed, the container is automatically closed when the associated message is sent or disposed IDisposable.

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

public static ISDTContainer GetContainer(
	IMessage message
)

Public Shared Function GetContainer ( 
	message As IMessage
) As ISDTContainer

public:
static ISDTContainer^ GetContainer(
	IMessage^ message
)

Parameters

message: Type: SolaceSystems.Solclient.MessagingIMessage
Message to get the container from.

Return Value

Type: ISDTContainer
A IMapContainer or IStreamContainer, if they exist; null, otherwise

Exceptions

Exception	Condition
ArgumentNullException	Thrown when message is null.
OperationErrorException	Thrown when an error occurs. In this case ReturnCode and SDKErrorInfo are accessible from OperationErrorException and contain more information.
FatalErrorException	Thrown when an unrecoverable error occurs.

Reference

SDTUtils Class

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