Caution
0 is treated as an invalid argument. This behavior is different from that
of the Encoding class.
FolkerKinzel.Strings
Text
Returns a corresponding Encoding object for a specified code
page number, whose properties EncoderFallback and
DecoderFallback are set to the desired values.
Definition
Namespace: FolkerKinzel.Strings
Assembly: FolkerKinzel.Strings (in FolkerKinzel.Strings.dll) Version: 9.4.0+10a7d4d71aa960998e32ac0ac6c4fcbe4164c917
An Encoding object that corresponds to the specified code page number and whose properties EncoderFallback and DecoderFallback are set to the desired values. If no match is found, a corresponding Encoding object for UTF-8 is returned by default. If the method is called with true as an argument for the throwOnInvalidCodePage parameter, an ArgumentException will be thrown instead.
Assembly: FolkerKinzel.Strings (in FolkerKinzel.Strings.dll) Version: 9.4.0+10a7d4d71aa960998e32ac0ac6c4fcbe4164c917
C#
public static Encoding GetEncoding(
int codePage,
EncoderFallback encoderFallback,
DecoderFallback decoderFallback,
bool throwOnInvalidCodePage = false
)VB
Public Shared Function GetEncoding (
codePage As Integer,
encoderFallback As EncoderFallback,
decoderFallback As DecoderFallback,
Optional throwOnInvalidCodePage As Boolean = false
) As EncodingC++
public:
static Encoding^ GetEncoding(
int codePage,
EncoderFallback^ encoderFallback,
DecoderFallback^ decoderFallback,
bool throwOnInvalidCodePage = false
)F#
static member GetEncoding :
codePage : int *
encoderFallback : EncoderFallback *
decoderFallback : DecoderFallback *
?throwOnInvalidCodePage : bool
(* Defaults:
let _throwOnInvalidCodePage = defaultArg throwOnInvalidCodePage false
*)
-> Encoding Parameters
- codePage Int32
The code page number.
- encoderFallback EncoderFallback
- An object that provides an error handling mechanism if a character cannot be encoded with the Encoding object.
- decoderFallback DecoderFallback
- An object that provides an error handling mechanism if a Byte sequence cannot be decoded with the Encoding object .
- throwOnInvalidCodePage Boolean (Optional)
- Pass true to have the method throw an ArgumentException if codePage could not be converted.
Return Value
EncodingAn Encoding object that corresponds to the specified code page number and whose properties EncoderFallback and DecoderFallback are set to the desired values. If no match is found, a corresponding Encoding object for UTF-8 is returned by default. If the method is called with true as an argument for the throwOnInvalidCodePage parameter, an ArgumentException will be thrown instead.
Remarks
.NET Standard and .NET 5.0 or higher recognize by default only a small number
of character sets. The method overrides this default setting.
Exceptions
| ArgumentNullException | encoderFallback or decoderFallback is null. |
| ArgumentOutOfRangeException | codePage is less than 1 or greater than 65535. This exception is only thrown if the optional parameter throwOnInvalidCodePage is true. |
| ArgumentException | codePage could not be mapped to a Encoding object. This exception is only thrown if the optional parameter throwOnInvalidCodePage is true. |