UnicodeEncoding::GetMaxByteCount Method (Int32)
Calculates the maximum number of bytes produced by encoding the specified number of characters.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- charCount
-
Type:
System::Int32
The number of characters to encode.
Return Value
Type: System::Int32The maximum number of bytes produced by encoding the specified number of characters.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | charCount is less than zero. -or- The resulting number of bytes is greater than the maximum number that can be returned as an integer. |
| EncoderFallbackException | A fallback occurred (see Character Encoding in the .NET Framework for fuller explanation) -and- EncoderFallback is set to EncoderExceptionFallback. |
To calculate the exact array size required by GetBytes to store the resulting bytes, the application uses GetByteCount. To calculate the maximum array size, the application should use GetMaxByteCount. The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.
GetMaxByteCount retrieves a worst-case number, including the worst case for the currently selected EncoderFallback. If a fallback is chosen with a potentially large string, GetMaxByteCount can return large values.
In most cases, this method retrieves reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach using GetByteCount or Encoder::Convert.
GetMaxByteCount has no relation to GetChars. If your application needs a similar function to use with GetChars, it should use GetMaxCharCount.
Note |
|---|
GetMaxByteCount(N) is not necessarily the same value as N* GetMaxByteCount(1). |
The following example demonstrates how to use the GetMaxByteCount method to return the maximum number of bytes required to encode a specified number of characters.
using namespace System; using namespace System::Text; int main() { UnicodeEncoding^ Unicode = gcnew UnicodeEncoding; int charCount = 2; int maxByteCount = Unicode->GetMaxByteCount( charCount ); Console::WriteLine( "Maximum of {0} bytes needed to encode {1} characters.", maxByteCount, charCount ); }
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
