Unpacking.UnpackArrayLength Method (Byte[])

UnpackingUnpackArrayLength Method (Byte)

Unpacks length of the array from the head of specified byte array.

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

Syntax

public static UnpackingResult<Nullable<long>> UnpackArrayLength(
	byte[] source
)

Public Shared Function UnpackArrayLength ( 
	source As Byte()
) As UnpackingResult(Of Nullable(Of Long))

public:
static UnpackingResult<Nullable<long long>> UnpackArrayLength(
	array<unsigned char>^ source
)

static member UnpackArrayLength : 
        source : byte[] -> UnpackingResult<Nullable<int64>>

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

Type: UnpackingResultNullableInt64
The UnpackingResultT of nullable Int64 which contains unpacked length of the array 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 nullable Int64.

Remarks

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

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