Unpacker.ReadArrayLength Method

UnpackerReadArrayLength Method

Reads next array length value from current stream.

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

Syntax

public virtual bool ReadArrayLength(
	out long result
)

Public Overridable Function ReadArrayLength ( 
	<OutAttribute> ByRef result As Long
) As Boolean

public:
virtual bool ReadArrayLength(
	[OutAttribute] long long% result
)

abstract ReadArrayLength : 
        result : int64 byref -> bool 
override ReadArrayLength : 
        result : int64 byref -> bool

Parameters

result: Type: SystemInt64
The array length 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.
MessageTypeException	A value read from data source is not an array.

Reference

Unpacker Class

MsgPack Namespace