IVsSettingsWriter.WriteSettingString Method
Stores a string value 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 WriteSettingString ( _
pszSettingName As String, _
pszSettingValue As String _
) As Integer
int WriteSettingString(
string pszSettingName,
string pszSettingValue
)
int WriteSettingString(
[InAttribute] String^ pszSettingName,
[InAttribute] String^ pszSettingValue
)
abstract WriteSettingString :
pszSettingName:string *
pszSettingValue:string -> int
function WriteSettingString(
pszSettingName : String,
pszSettingValue : String
) : int
Parameters
pszSettingName
Type: String[in] String uniquely identifying the data element to be stored
pszSettingValue
Type: String[in] String to be stored as the specified data element of the Visual Studio settings file.
Return Value
Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
COM Signature
From vsshell80.idl:
HRESULT WriteSettingString(
LPCOLESTR pszSettingName,
LPCOLESTR pszSettingValue
);
The names specified by pfSettingValue need to be unique within a Custom Settings Point (settings category), as the IDE uses the Custom Settings Point identifying GUID and the value of pfSettingValue to identify each saved setting.
If more than one IVsSettingsWriter method is called with the same value of pszSettingName, the original value is overwritten in the Visual Studio settings file.
Because the value of pfSettingValue must be unique, the order of calling WriteSettingString 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: Export Settings By Using Interop Assemblies
How to: Export Settings By Using the Managed Package Framework