Unpacking.UnpackUInt16 Method (Stream)

UnpackingUnpackUInt16 Method (Stream)

Unpacks UInt16 value from the specified Stream.

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

Syntax

[CLSCompliantAttribute(false)]
public static ushort UnpackUInt16(
	Stream source
)

<CLSCompliantAttribute(false)>
Public Shared Function UnpackUInt16 ( 
	source As Stream
) As UShort

public:
[CLSCompliantAttribute(false)]
static unsigned short UnpackUInt16(
	Stream^ source
)

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

source: Type: System.IOStream
The Stream which contains Message Pack binary stream.

Type: UInt16
The unpacked UInt16 value.

Exceptions

Exception	Condition
ArgumentNullException	source is null.
ArgumentException	The CanRead of source is false.
UnpackException	source is not valid MessagePack stream. Note that the state of source will be unpredictable espicially it is not seekable.
MessageTypeException	The unpacked result in the source is not compatible to UInt16. Note that the state of source will be unpredictable espicially it is not seekable.

Remarks

The processed bytes count can be calculated via Position of source when the CanSeek is true.

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