Unpacking.UnpackBoolean Method (Byte[])

UnpackingUnpackBoolean Method (Byte)

Unpacks the boolean from the head of specified byte array.

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

Syntax

public static UnpackingResult<bool> UnpackBoolean(
	byte[] source
)

Public Shared Function UnpackBoolean ( 
	source As Byte()
) As UnpackingResult(Of Boolean)

public:
static UnpackingResult<bool> UnpackBoolean(
	array<unsigned char>^ source
)

static member UnpackBoolean : 
        source : byte[] -> UnpackingResult<bool>

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

Type: UnpackingResultBoolean
The UnpackingResultT of Boolean which contains unpacked the boolean 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 Boolean.

Remarks

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

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