Unpacking.UnpackObject Method (Byte[])

UnpackingUnpackObject Method (Byte)

Unpacks the MessagePackObject which represents the value which has MessagePack type semantics. from the head of specified byte array.

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

Syntax

public static UnpackingResult<MessagePackObject> UnpackObject(
	byte[] source
)

Public Shared Function UnpackObject ( 
	source As Byte()
) As UnpackingResult(Of MessagePackObject)

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

static member UnpackObject : 
        source : byte[] -> UnpackingResult<MessagePackObject>

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

Type: UnpackingResultMessagePackObject
The UnpackingResultT of MessagePackObject which contains unpacked the MessagePackObject which represents the value which has MessagePack type semantics. 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 MessagePackObject.

Remarks

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

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