Unpacking.UnpackDictionary Method (Byte[])

UnpackingUnpackDictionary Method (Byte)

Unpacks the dictionary from the head of specified byte array.

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

Syntax

public static UnpackingResult<MessagePackObjectDictionary> UnpackDictionary(
	byte[] source
)

Public Shared Function UnpackDictionary ( 
	source As Byte()
) As UnpackingResult(Of MessagePackObjectDictionary)

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

static member UnpackDictionary : 
        source : byte[] -> UnpackingResult<MessagePackObjectDictionary>

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

Type: UnpackingResultMessagePackObjectDictionary
The UnpackingResultT of MessagePackObjectDictionary which contains unpacked the dictionary 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 MessagePackObjectDictionary.
MessageNotSupportedException	The items count of the underlying collection body is over MaxValue.

Remarks

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

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