Share via


SettingsStore.GetString Method

Definition

Overloads

GetString(String, String, String)

Returns the value of the requested property whose data type is String.

GetString(String, String)

Returns the value of the requested property whose data type is String.

GetString(String, String, String)

Returns the value of the requested property whose data type is String.

public:
 abstract System::String ^ GetString(System::String ^ collectionPath, System::String ^ propertyName, System::String ^ defaultValue);
public:
 abstract Platform::String ^ GetString(Platform::String ^ collectionPath, Platform::String ^ propertyName, Platform::String ^ defaultValue);
 abstract std::wstring GetString(std::wstring const & collectionPath, std::wstring const & propertyName, std::wstring const & defaultValue);
public abstract string GetString (string collectionPath, string propertyName, string defaultValue);
abstract member GetString : string * string * string -> string
Public MustOverride Function GetString (collectionPath As String, propertyName As String, defaultValue As String) As String

Parameters

collectionPath
String

Path of the collection of the property.

propertyName
String

Name of the property.

defaultValue
String

Value to be returned if the property does not exist.

Returns

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

Exceptions

Throws this exception if the property is of different type.

Remarks

This method is safe to access from any thread.

Applies to

GetString(String, String)

Returns the value of the requested property whose data type is String.

public:
 abstract System::String ^ GetString(System::String ^ collectionPath, System::String ^ propertyName);
public:
 abstract Platform::String ^ GetString(Platform::String ^ collectionPath, Platform::String ^ propertyName);
 abstract std::wstring GetString(std::wstring const & collectionPath, std::wstring const & propertyName);
public abstract string GetString (string collectionPath, string propertyName);
abstract member GetString : string * string -> string
Public MustOverride Function GetString (collectionPath As String, propertyName As String) As String

Parameters

collectionPath
String

Path of the collection of the property.

propertyName
String

Name of the property.

Returns

Value of the property.

Exceptions

Throws this exception if the property is of different type or if it does not exist.

Remarks

This method is safe to access from any thread.

Applies to