Unpacker.ReadString Method

UnpackerReadString Method

Reads next utf-8 encoded string value from current stream.

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

Syntax

public virtual bool ReadString(
	out string result
)

Public Overridable Function ReadString ( 
	<OutAttribute> ByRef result As String
) As Boolean

public:
virtual bool ReadString(
	[OutAttribute] String^% result
)

abstract ReadString : 
        result : string byref -> bool 
override ReadString : 
        result : string byref -> bool

Parameters

result: Type: SystemString
The decoded utf-8 encoded string 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 a raw.

Reference

Unpacker Class

MsgPack Namespace