IVsSettingsReader.ReadSettingString Method
Returns the value of a String object stored in the Visual Studio settings file.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
Syntax
'Declaration
Function ReadSettingString ( _
pszSettingName As String, _
<OutAttribute> ByRef pbstrSettingValue As String _
) As Integer
int ReadSettingString(
string pszSettingName,
out string pbstrSettingValue
)
int ReadSettingString(
[InAttribute] String^ pszSettingName,
[OutAttribute] String^% pbstrSettingValue
)
abstract ReadSettingString :
pszSettingName:string *
pbstrSettingValue:string byref -> int
function ReadSettingString(
pszSettingName : String,
pbstrSettingValue : String
) : int
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.Int32
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.
.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
Microsoft.VisualStudio.Shell.Interop Namespace
Other Resources
How to: Use Interop Assemblies to Import Settings
How to: Import Settings By Using the Managed Package Framework