TextEncodingConverterGetEncoding(String, EncoderFallback, DecoderFallback, Boolean) Method

Returns a corresponding Encoding object for the specified identifier of a character set, 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

C#

public static Encoding GetEncoding(
	string? encodingWebName,
	EncoderFallback encoderFallback,
	DecoderFallback decoderFallback,
	bool throwOnInvalidWebName = false
)

VB

Public Shared Function GetEncoding ( 
	encodingWebName As String,
	encoderFallback As EncoderFallback,
	decoderFallback As DecoderFallback,
	Optional throwOnInvalidWebName As Boolean = false
) As Encoding

C++

public:
static Encoding^ GetEncoding(
	String^ encodingWebName, 
	EncoderFallback^ encoderFallback, 
	DecoderFallback^ decoderFallback, 
	bool throwOnInvalidWebName = false
)

F#

static member GetEncoding : 
        encodingWebName : string * 
        encoderFallback : EncoderFallback * 
        decoderFallback : DecoderFallback * 
        ?throwOnInvalidWebName : bool 
(* Defaults:
        let _throwOnInvalidWebName = defaultArg throwOnInvalidWebName false
*)
-> Encoding

Parameters

encodingWebName String: The identifier of the character set.
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 .
throwOnInvalidWebName Boolean (Optional): Pass true to have the method throw an ArgumentException if encodingWebName could not be converted.

Return Value

Encoding
An Encoding object that corresponds to the specified identifier of a character set 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 throwOnInvalidWebName 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.
ArgumentException	encodingWebName could not be mapped to a Encoding object. An exception is only thrown if the optional parameter throwOnInvalidWebName is true.