IVsSettingsReader::ReadSettingString Method (String^, String^)
Visual Studio 2015
Returns the value of a String object stored in the Visual Studio settings file.
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
int ReadSettingString(
String^ pszSettingName,
[OutAttribute] String^% pbstrSettingValue
)
Parameters
- pszSettingName
-
Type:
System::String^
[in] String uniquely identifying the data element to be retrieved.
- pbstrSettingValue
-
Type:
System::String^
[out] String retrieved from the specified data element of the Visual Studio settings file.
Return Value
Type: System::Int32If the method succeeds, it returns S_OK. If it fails, it returns an error code.
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.
Show: