SDTUtils.CreateStream Method (IMessage, Int32)

Solclient

previous page next page

Solclient

SDTUtilsCreateStream Method (IMessage, Int32)

version: 7.2.1.27

Creates a stream container (IStreamContainer) in the binary attachment part of the given message. Any existing data is overwritten. The returned IStreamContainer instance can be later used to add SDT fields. It is recommended to Close the IStreamContainer when done. If it is not explicitly closed, the stream is automatically closed when the associated message is disposed IDisposable.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this stream 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 IStreamContainer CreateStream(
	IMessage message,
	int initialSize
)

Public Shared Function CreateStream ( 
	message As IMessage,
	initialSize As Integer
) As IStreamContainer

public:
static IStreamContainer^ CreateStream(
	IMessage^ message, 
	int initialSize
)

Parameters

message: Type: SolaceSystems.Solclient.MessagingIMessage
The message to create the map container in.
initialSize: Type: SystemInt32
This parameter must be greater than or equal to zero. It hints to the size of the stream to be created, it is used to determine the size of the datablock to allocate. If it is too small for the subsequently created stream, a larger datablock is allocated when necessary and existing SDT data is copied into place. This reallocation can negatively affect performance.

Return Value

Type: IStreamContainer
The created stream container.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when the 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.
ArgumentOutOfRangeException	Thrown when initialSize is less than zero.

Reference

SDTUtils Class

CreateStream Overload

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