UnicodeEncoding.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)] [ComVisibleAttribute(false)] public override int GetChars( byte* bytes, int byteCount, char* chars, int charCount )
- Type: System.Byte*
A pointer to the first byte to decode.
- Type: System.Int32
The number of bytes to decode.
- Type: System.Char*
A pointer to the location at which to start writing the resulting set of characters.
- Type: System.Int32
The maximum number of characters to write.
Return ValueType: System.Int32
The actual number of characters written at the location indicated by the chars parameter.
bytes is null (Nothing).
chars is null (Nothing).
byteCount or charCount is less than zero.
Error detection is enabled, and bytes contains an invalid sequence of bytes.
charCount is less than the resulting number of characters.
A fallback occurred (see Character Encoding in the .NET Framework for fuller explanation)
To calculate the exact array size that GetChars requires to store the resulting characters, the application uses GetCharCount. To calculate the maximum array size, the application should use GetMaxCharCount. The GetCharCount method generally allocates 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.
If the range of bytes to be decoded includes the byte order mark (BOM) and the byte array was returned by a method of a non-BOM aware type, the character U+FFFE is included in the character array returned by this method. You can remove it by calling the String.TrimStart method.
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 should use the Decoder or the Encoder object provided by the GetDecoder or the GetEncoder method, respectively.
Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.