10.24.0

IStreamContainerGetStream Method

Opens the contained sub-stream with the given name. The returned IStreamContainer is ready for read and write operations. It is recommended to Close the IStreamContainer 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.

Definition

Namespace: SolaceSystems.Solclient.Messaging.SDT
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.24.0
C#
IStreamContainer GetStream()

Return Value

IStreamContainer
An opened sub-stream

Exceptions

EndOfStreamException Thrown when the end of stream is reached.
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.
InvalidOperationException Thrown when the container is already closed.

See Also