Unpacking.UnpackNull Method (Stream)

UnpackingUnpackNull Method (Stream)

Unpacks the nil value from the specified Stream.

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

Syntax

public static Object UnpackNull(
	Stream source
)

Public Shared Function UnpackNull ( 
	source As Stream
) As Object

public:
static Object^ UnpackNull(
	Stream^ source
)

static member UnpackNull : 
        source : Stream -> Object

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

Type: Object
The unpacked the nil 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 Object. 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.