Unpacking.UnpackString Method (Byte[], Int32)

UnpackingUnpackString Method (Byte, Int32)

Unpacks String value from specified offsetted byte array with UTF-8 encoding.

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

Syntax

public static UnpackingResult<string> UnpackString(
	byte[] source,
	int offset
)

Public Shared Function UnpackString ( 
	source As Byte(),
	offset As Integer
) As UnpackingResult(Of String)

public:
static UnpackingResult<String^> UnpackString(
	array<unsigned char>^ source, 
	int offset
)

static member UnpackString : 
        source : byte[] * 
        offset : int -> UnpackingResult<string>

source: Type: SystemByte
The byte array which contains Message Pack binary stream.
offset: Type: SystemInt32
The offset to be unpacking start with.

Type: UnpackingResultString
The UnpackingResultT of String which contains unpacked String value and processed bytes count.

Exceptions

Exception	Condition
ArgumentNullException	source is null.
ArgumentException	source is empty. Or, the length of source is not greater than offset.
ArgumentOutOfRangeException	offset is negative value.
UnpackException	source is not valid MessagePack stream.
MessageTypeException	The unpacked result in the source is not compatible to String. Or, the unpacked result in the source is invalid as specified encoding byte stream.

Remarks

Invocation of this method is equivalant to call UnpackString(Byte, Int32) with offset is 0.

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