UTF8Encoding.GetByteCount Method (Char*, Int32)
Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer.
This API is not CLS-compliant. Namespace: System.Text
Assemblies: System.Text.Encoding.Extensions (in System.Text.Encoding.Extensions.dll)
mscorlib (in mscorlib.dll)
[CLSCompliantAttribute(false)] public override int GetByteCount( char* chars, int count )
- Type: System.Char*
A pointer to the first character to encode.
- Type: System.Int32
The number of characters to encode.
Return ValueType: System.Int32
The number of bytes produced by encoding the specified characters.
chars is null.
count is less than zero.
The resulting number of bytes is greater than the maximum number that can be returned as an integer.
Error detection is enabled, and chars contains an invalid sequence of characters.
A fallback occurred (see Character Encoding in the .NET Framework for a complete explanation)
To calculate the exact array size required by the GetBytes method to store the resulting bytes, you call the GetByteCount method. To calculate the maximum array size, you call the GetMaxByteCount method. The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.
With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Without error detection, invalid sequences are ignored, and no exception is thrown.
To ensure that the encoded bytes are decoded properly when they are saved as a file or as a stream, you can prefix a stream of encoded bytes with a preamble. Inserting the preamble at the beginning of a byte stream (such as at the beginning of a series of bytes to be written to a file) is the developer's responsibility, and the number of bytes in the preamble is not reflected in the value returned by the GetByteCount method.
Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.