Export (0) Print
Expand All

UTF8Encoding.GetChars Method (Byte*, Int32, Char*, Int32)

Note: This method is new in the .NET Framework version 2.0.

Decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer.

This method is not CLS-compliant.  

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)

[CLSCompliantAttribute(false)] 
[ComVisibleAttribute(false)] 
public override int GetChars (
	byte* bytes,
	int byteCount,
	char* chars,
	int charCount
)
J# does not support APIs that consume or return unsafe types.
JScript does not support APIs that consume or return unsafe types.

Parameters

bytes

A pointer to the first byte to decode.

byteCount

The number of bytes to decode.

chars

A pointer to the location at which to start writing the resulting set of characters.

charCount

The maximum number of characters to write.

Return Value

The actual number of characters written at the location indicated by chars.

Exception typeCondition

ArgumentNullException

bytes is a null reference (Nothing in Visual Basic).

-or-

chars is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

byteCount or charCount is less than zero.

ArgumentException

Error detection is enabled, and bytes contains an invalid sequence of bytes.

-or-

charCount is less than the resulting number of characters.

To calculate the exact array size required by GetChars to store the resulting characters, use GetCharCount. To calculate the maximum array size, use GetMaxCharCount. The GetCharCount method generally allows you to allocate less memory, whereas the GetMaxCharCount method generally executes faster.

With error detection, an invalid sequence causes this method to throw an ArgumentException. Without error detection, invalid sequences are ignored, and no exception is thrown.

If the data to be converted is available only in sequential blocks (such as data read from a stream) or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft