Unpacker.ReadObject Method

UnpackerReadObject Method

Reads next value from current stream.

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

Syntax

public virtual bool ReadObject(
	out MessagePackObject result
)

Public Overridable Function ReadObject ( 
	<OutAttribute> ByRef result As MessagePackObject
) As Boolean

public:
virtual bool ReadObject(
	[OutAttribute] MessagePackObject% result
)

abstract ReadObject : 
        result : MessagePackObject byref -> bool 
override ReadObject : 
        result : MessagePackObject byref -> bool

Parameters

result: Type: MsgPackMessagePackObject
The MessagePackObject which represents a value read from current stream to be stored when operation is succeeded.

Return Value

Type: Boolean
true if expected value was read from stream; false if no more data on the stream. Note that this method throws exception for unexpected state. See exceptions section.

Exceptions

Exception	Condition
InvalidMessagePackStreamException	Cannot read a value because the underlying stream unexpectedly ends.

Reference

Unpacker Class

MsgPack Namespace