Unpacking.UnpackBinary Method (Byte[])

UnpackingUnpackBinary Method (Byte)

Unpacks the raw binary from the head of specified byte array.

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

Syntax

public static UnpackingResult<byte[]> UnpackBinary(
	byte[] source
)

Public Shared Function UnpackBinary ( 
	source As Byte()
) As UnpackingResult(Of Byte())

public:
static UnpackingResult<array<unsigned char>^> UnpackBinary(
	array<unsigned char>^ source
)

static member UnpackBinary : 
        source : byte[] -> UnpackingResult<byte[]>

source: Type: SystemByte
The byte array which contains Message Pack binary stream.

Type: UnpackingResultByte
The UnpackingResultT of Byte[] which contains unpacked the raw binary and processed bytes count.

Exceptions

Exception	Condition
ArgumentNullException	source is null.
ArgumentException	source is empty.
UnpackException	source is not valid MessagePack stream.
MessageTypeException	The unpacked result in the source is not compatible to Byte[].
MessageNotSupportedException	The items count of the underlying collection body is over MaxValue.

Remarks

Invocation of this method is equivalant to call UnpackBinary(Byte, Int32) with offset is 0.

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