Share via


IVsSettingsReader.ReadSettingString(String, String) Method

Definition

Returns the value of a String object stored in the Visual Studio settings file.

public:
 int ReadSettingString(System::String ^ pszSettingName, [Runtime::InteropServices::Out] System::String ^ % pbstrSettingValue);
int ReadSettingString(std::wstring const & pszSettingName, [Runtime::InteropServices::Out] std::wstring const & & pbstrSettingValue);
public int ReadSettingString (string pszSettingName, out string pbstrSettingValue);
abstract member ReadSettingString : string * string -> int
Public Function ReadSettingString (pszSettingName As String, ByRef pbstrSettingValue As String) As Integer

Parameters

pszSettingName
String

[in] String uniquely identifying the data element to be retrieved.

pbstrSettingValue
String

[out] String retrieved from the specified data element of the Visual Studio settings file.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The names specified by pfSettingValue need to be unique within a Custom Settings Point, as the IDE uses the Custom Settings Point identifying GUID and the value of pfSettingValue to identify each saved setting.

Because the value of pfSettingValue must be unique, the order of calling ReadSettingString with respect to other methods of the IVsSettingsReader interface is not relevant.

Applies to