ResourceManager.GetString Method (String)
Updated: May 2012
Returns the value of the specified String resource.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Overridable Function GetString ( _ name As String _ ) As String 'Usage Dim instance As ResourceManager Dim name As String Dim returnValue As String returnValue = instance.GetString(name)
- Type: System.String
The name of the resource to get.
Return ValueType: System.String
The value of the resource localized for the caller's current culture settings. If a match is not possible, Nothing is returned.
The name parameter is Nothing.
The value of the specified resource is not a string.
No usable set of resources has been found, and there are no neutral culture resources.
The default culture's resources reside in a satellite assembly that could not be found.
The resource that is returned is localized for the culture determined by the cultural settings of the current Thread (this is accomplished using the current thread's CurrentUICulture property). If the resource has not been localized for that culture, the resource that is returned is localized for a best match (this is accomplished using the Parent property). Otherwise, Nothing is returned.
If no usable set of resources has been found, the ResourceManager falls back on the neutral culture's resources, which are expected to be in the main assembly. If an appropriate culture resource has not been found, a MissingManifestResourceException is thrown.
The GetString method is thread-safe.
This method can throw more exceptions than are listed. One reason this might occur is if a method that this method calls throws an exception. For example, a FileLoadException might be thrown if an error was made deploying or installing a satellite assembly, or a SerializationException might be thrown if a user-defined type throws a user-defined exception when the type is deserialized.
The following code example gets a string resource using the current UI culture.
Imports System Imports System.Globalization Imports System.Threading Imports System.Resources Imports System.Reflection Class ResourcesExample Public Shared Sub Main() ' Create a resource manager to retrieve resources. Dim rm As New ResourceManager("items", _ [Assembly].GetExecutingAssembly()) ' Retrieve the value of the string resource named "welcome". ' The resource manager will retrieve the value of the ' localized resource using the caller's current culture setting. Dim str As String = rm.GetString("welcome") Console.WriteLine(str) End Sub End Class
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.