IVsSettingsWriter.WriteSettingBoolean(String, Int32) Method

Definition

Stores the value of a Boolean object in the Visual Studio settings file.

public:
 int WriteSettingBoolean(System::String ^ pszSettingName, int fSettingValue);
public:
 int WriteSettingBoolean(Platform::String ^ pszSettingName, int fSettingValue);
int WriteSettingBoolean(std::wstring const & pszSettingName, int fSettingValue);
public int WriteSettingBoolean (string pszSettingName, int fSettingValue);
abstract member WriteSettingBoolean : string * int -> int
Public Function WriteSettingBoolean (pszSettingName As String, fSettingValue As Integer) As Integer

Parameters

pszSettingName
String

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

fSettingValue
Int32

[in] Boolean value to be stored as 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

COM Signature

From vsshell80.idl:

HRESULT WriteSettingBoolean(  
   LPCOLESTR pszSettingName,  
   BOOL fSettingValue  
);  

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 WriteSettingBoolean with respect to other methods of the IVsSettingsReader interface is not relevant.

Applies to