IVsSettingsWriter.WriteSettingLong(String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int WriteSettingLong(System::String ^ pszSettingName, int lSettingValue);

public:
 int WriteSettingLong(Platform::String ^ pszSettingName, int lSettingValue);

int WriteSettingLong(std::wstring const & pszSettingName, int lSettingValue);

public int WriteSettingLong (string pszSettingName, int lSettingValue);

abstract member WriteSettingLong : string * int -> int

Public Function WriteSettingLong (pszSettingName As String, lSettingValue As Integer) As Integer

Parameters

pszSettingName: String

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

lSettingValue: Int32

[in] Long (32-bit Integer) value to be stored as the specified data element of the Visual Studio settings file.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT WriteSettingLong  
   (LPCOLESTR pszSettingName,   
   long lSettingValue  
   );

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

Applies to

Share via