TextEncodingConverterGetEncoding(String, Boolean) Method

Returns a corresponding Encoding object for the specified identifier of a character set.

Definition

Namespace: FolkerKinzel.Strings
Assembly: FolkerKinzel.Strings (in FolkerKinzel.Strings.dll) Version: 9.4.0+10a7d4d71aa960998e32ac0ac6c4fcbe4164c917

C#

public static Encoding GetEncoding(
	string? encodingWebName,
	bool throwOnInvalidWebName = false
)

VB

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

C++

public:
static Encoding^ GetEncoding(
	String^ encodingWebName, 
	bool throwOnInvalidWebName = false
)

F#

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

Parameters

encodingWebName String: The identifier of the character set.
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 character set identifier. If no match is found, UTF8 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 later only recognize a small number of character sets by default. The method overrides this default.

The properties EncoderFallback and DecoderFallback of the generated Encoding object are set to ReplacementFallback.

Exceptions

ArgumentException

encodingWebName could not be mapped to a Encoding object. An exception is only thrown if the optional parameter throwOnInvalidWebName is true.