SettingsStore.GetString Method (String, String, String)

Returns the value of the requested property whose data type is [!:SettingsType.String].

Namespace:  Microsoft.VisualStudio.Settings
Assemblies:   Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
  Microsoft.VisualStudio.Settings (in Microsoft.VisualStudio.Settings.dll)

Syntax

'Declaration
Public MustOverride Function GetString ( _
    collectionPath As String, _
    propertyName As String, _
    defaultValue As String _
) As String

public abstract string GetString(
    string collectionPath,
    string propertyName,
    string defaultValue
)

public:
virtual String^ GetString(
    String^ collectionPath, 
    String^ propertyName, 
    String^ defaultValue
) abstract

abstract GetString : 
        collectionPath:string * 
        propertyName:string * 
        defaultValue:string -> string

public abstract function GetString(
    collectionPath : String, 
    propertyName : String, 
    defaultValue : String
) : String

Parameters

• collectionPath
  Type: String

  Path of the collection of the property.

• propertyName
  Type: String

  Name of the property.

• defaultValue
  Type: String

  Value to be returned if the property does not exist.

Return Value

Type: String
If the property does not exist, it returns the defaultValue passed in.

Exceptions

Exception	Condition
ArgumentException	Throws this exception if the property is of different type.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

SettingsStore Class

GetString Overload

Microsoft.VisualStudio.Settings Namespace