Unpacking.UnpackArray Method (Stream)

UnpackingUnpackArray Method (Stream)

Unpacks the array value from the specified Stream.

Namespace: MsgPack
Assembly: MsgPack (in MsgPack.dll) Version: 0.6.0

Syntax

public static IList<MessagePackObject> UnpackArray(
	Stream source
)

Public Shared Function UnpackArray ( 
	source As Stream
) As IList(Of MessagePackObject)

public:
static IList<MessagePackObject>^ UnpackArray(
	Stream^ source
)

static member UnpackArray : 
        source : Stream -> IList<MessagePackObject>

source: Type: System.IOStream
The Stream which contains Message Pack binary stream.

Type: IListMessagePackObject
The unpacked the array value.

Exceptions

Exception	Condition
ArgumentNullException	source is null.
ArgumentException	The CanRead of source is false.
UnpackException	source is not valid MessagePack stream. Note that the state of source will be unpredictable espicially it is not seekable.
MessageTypeException	The unpacked result in the source is not compatible to IListT. Note that the state of source will be unpredictable espicially it is not seekable.
MessageNotSupportedException	The items count of the underlying collection body is over MaxValue.

Remarks

The processed bytes count can be calculated via Position of source when the CanSeek is true.

When the type of packed value is not known, use UnpackObject(Stream) instead.