ResourceSet.GetString Method

Definition

Namespace:

System.Resources

Assembly:

System.Runtime.dll

Returns a String resource with a specified name.

Overloads

GetString(String)	Searches for a String resource with the specified name.
GetString(String, Boolean)	Searches for a String resource with the specified name in a case-insensitive manner, if requested.

GetString(String)

Source:

ResourceSet.cs

Searches for a String resource with the specified name.

public:
 virtual System::String ^ GetString(System::String ^ name);

public virtual string? GetString (string name);

abstract member GetString : string -> string
override this.GetString : string -> string

Public Overridable Function GetString (name As String) As String

Parameters

name

String

Name of the resource to search for.

Returns

String

The value of a resource, if the value is a String.

Exceptions

ArgumentNullException

The name parameter is null.

InvalidOperationException

The resource specified by name is not a String.

ObjectDisposedException

The object has been closed or disposed.

GetString(String, Boolean)

Source:

ResourceSet.cs

Searches for a String resource with the specified name in a case-insensitive manner, if requested.

public:
 virtual System::String ^ GetString(System::String ^ name, bool ignoreCase);

public virtual string? GetString (string name, bool ignoreCase);

abstract member GetString : string * bool -> string
override this.GetString : string * bool -> string

Public Overridable Function GetString (name As String, ignoreCase As Boolean) As String

Parameters

name

String

Name of the resource to search for.

ignoreCase

Boolean

Indicates whether the case of the case of the specified name should be ignored.

Returns

String

The value of a resource, if the value is a String.

Exceptions

ArgumentNullException

The name parameter is null.

InvalidOperationException

The resource specified by name is not a String.

ObjectDisposedException

The object has been closed or disposed.

Remarks

If the value of the ignoreCase parameter is true, a resource with the name "Resource" is equivalent to the resource with the name "resource". Note, however, that this method always performs case-insensitive string comparisons using CultureInfo.InvariantCulture. The advantage is that results of case-insensitive string comparisons performed by this method are the same on all computers regardless of culture. The disadvantage is that the results are not consistent with the casing rules of all cultures.

For example, the Turkish alphabet has two versions of the character I: one with a dot and one without a dot. In Turkish, the character I (Unicode 0049) is considered the uppercase version of a different character ı (Unicode 0131). The character i (Unicode 0069) is considered the lowercase version of yet another character İ (Unicode 0130). According to these casing rules, a case-insensitive string comparison of the characters i (Unicode 0069) and I (Unicode 0049) should fail for the culture "tr-TR" (Turkish in Turkey). Using the GetString method with ignoreCase set to true, this comparison succeeds.