Unpacking.UnpackUInt16 Method (Byte[])

UnpackingUnpackUInt16 Method (Byte)

Unpacks UInt16 value from the head of specified byte array.

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

Syntax

[CLSCompliantAttribute(false)]
public static UnpackingResult<ushort> UnpackUInt16(
	byte[] source
)

<CLSCompliantAttribute(false)>
Public Shared Function UnpackUInt16 ( 
	source As Byte()
) As UnpackingResult(Of UShort)

public:
[CLSCompliantAttribute(false)]
static UnpackingResult<unsigned short> UnpackUInt16(
	array<unsigned char>^ source
)

[<CLSCompliantAttribute(false)>]
static member UnpackUInt16 : 
        source : byte[] -> UnpackingResult<uint16>

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

Type: UnpackingResultUInt16
The UnpackingResultT of UInt16 which contains unpacked UInt16 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 UInt16.

Remarks

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

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