Unpacking.UnpackExtendedTypeObject Method (Byte[])

UnpackingUnpackExtendedTypeObject Method (Byte)

Unpacks the MessagePackExtendedTypeObject which represents the extended type value. from the head of specified byte array.

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

Syntax

public static UnpackingResult<MessagePackExtendedTypeObject> UnpackExtendedTypeObject(
	byte[] source
)

Public Shared Function UnpackExtendedTypeObject ( 
	source As Byte()
) As UnpackingResult(Of MessagePackExtendedTypeObject)

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

static member UnpackExtendedTypeObject : 
        source : byte[] -> UnpackingResult<MessagePackExtendedTypeObject>

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

Type: UnpackingResultMessagePackExtendedTypeObject
The UnpackingResultT of MessagePackExtendedTypeObject which contains unpacked the MessagePackExtendedTypeObject which represents the extended type value. 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 MessagePackExtendedTypeObject.
MessageNotSupportedException	The items count of the underlying collection body is over MaxValue.

Remarks

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

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