Unpacking.UnpackObject Method (Byte[], Int32)

UnpackingUnpackObject Method (Byte, Int32)

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

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

Syntax

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

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

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

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

source: Type: SystemByte
The byte array which contains Message Pack binary stream.
offset: Type: SystemInt32
The offset to be unpacking start with.

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. Or, the length of source is not grator than offset.
ArgumentOutOfRangeException	offset is negative value.
UnpackException	source is not valid MessagePack stream.
MessageTypeException	The unpacked result in the source is not compatible to MessagePackObject.

Remarks

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