Unpacking.UnpackString Method (Byte[], Encoding)

UnpackingUnpackString Method (Byte, Encoding)

Unpacks String value from the head of specified byte array with specified encoding.

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

Syntax

public static UnpackingResult<string> UnpackString(
	byte[] source,
	Encoding encoding
)

Public Shared Function UnpackString ( 
	source As Byte(),
	encoding As Encoding
) As UnpackingResult(Of String)

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

static member UnpackString : 
        source : byte[] * 
        encoding : Encoding -> UnpackingResult<string>

source: Type: SystemByte
The byte array which contains Message Pack binary stream.
encoding: Type: System.TextEncoding
The Encoding to decode binary stream.

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

Exceptions

Exception	Condition
ArgumentNullException	source is null. Or, encoding is null.
ArgumentException	source is empty.
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 UTF-8 encoded 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.