Unpacking.UnpackUInt16 Method (Byte[], Int32)

UnpackingUnpackUInt16 Method (Byte, Int32)

Unpacks UInt16 value from the specified byte array.

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

Syntax

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

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

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

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

source: Type: SystemByte
The byte array which contains Message Pack binary stream.
offset: Type: SystemInt32
The offset to be unpacking start with.

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. Or, the length of source is not grator than offset.
ArgumentOutOfRangeException	offset is negative value.
UnpackException	source is not valid MessagePack stream.
MessageTypeException	The unpacked result in the source is not compatible to UInt16.

Remarks

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