Encoding.GetByteCount Method (Char*, Int32)
When overridden in a derived class, 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 (in System.Text.Encoding.dll)
mscorlib (in mscorlib.dll)
[<CLSCompliantAttribute(false)>] abstract GetByteCount : chars:nativeptr<char> * count:int -> int [<CLSCompliantAttribute(false)>] override GetByteCount : chars:nativeptr<char> * count:int -> int
- 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 a null reference (Nothing in Visual Basic).
count is less than zero.
A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)
To calculate the exact array size that GetBytes requires to store the resulting bytes, you should call the GetByteCount method. To calculate the maximum array size, call the GetMaxByteCount method. The GetByteCount method generally allows allocation of less memory, while the GetMaxByteCount method generally executes faster.
The method determines how many bytes result in encoding a set of Unicode characters, and the GetBytes(Char*, Int32, Byte*, Int32) method performs the actual encoding. The GetBytes method expects discrete conversions, in contrast to the Encoder.GetBytes method, which handles multiple conversions on a single input stream.
Your app may need to encode many input characters to a code page and process the characters using multiple calls. In this case, you probably need to maintain state between calls, taking into account the state that is persisted by the Encoder object being used.
If your app handles string inputs, you should use the string version of the GetBytes method.
The Unicode character buffer version of GetBytes allows some fast techniques, particularly with multiple calls using the Encoder object or inserting into existing buffers. Bear in mind, however, that this method version is sometimes unsafe, since pointers are required.
If your app must convert a large amount of data, it should reuse the output buffer. In this case, the GetBytes version that supports byte arrays is the best choice.
Consider using the Encoder.Convert method instead of GetByteCount. The conversion method converts as much data as possible, and does throw an exception if the output buffer is too small. For continuous encoding of a stream, this method is often the best choice.
Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.