Export (0) Print
Expand All

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

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 API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
public override int GetChars(
	byte* bytes,
	int byteCount,
	char* chars,
	int charCount
)

Parameters

bytes
Type: System.Byte*

A pointer to the first byte to decode.

byteCount
Type: System.Int32

The number of bytes to decode.

chars
Type: System.Char*

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

charCount
Type: System.Int32

The maximum number of characters to write.

Return Value

Type: System.Int32
The actual number of characters written at the location indicated by chars.

ExceptionCondition
ArgumentNullException

bytes is null.

-or-

chars is null.

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.

DecoderFallbackException

A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)

-and-

DecoderFallback is set to DecoderExceptionFallback.

To calculate the exact array size required by GetChars to store the resulting characters, the application uses GetCharCount. To calculate the maximum array size, the application should use GetMaxCharCount. The GetCharCount method generally allows allocation of less memory, while the GetMaxCharCount method generally executes faster.

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

Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application uses the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • SecurityCriticalAttribute 

    Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft