IVsShell.SetProperty(Int32, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Sets an environment property.

public:
 int SetProperty(int propid, System::Object ^ var);

public:
 int SetProperty(int propid, Platform::Object ^ var);

int SetProperty(int propid, winrt::Windows::Foundation::IInspectable const & var);

public int SetProperty (int propid, object var);

abstract member SetProperty : int * obj -> int

Public Function SetProperty (propid As Integer, var As Object) As Integer

Parameters

propid: Int32

[in] Identifier of the environment property. See __VSSPROPID.

var: Object

[in] VARIANT structure that contains information on how to set the property identified by propid.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsShell::SetProperty(  
   [in] VSSPROPID propid,  
   [in] VARIANT var  
);

The VARIANT values that are passed in can be different between property types. Click on the __VSSPROPID enumeration link (above) for a description of how to set up the VARIANT structure for different property values.

Applies to