IVsSccToolsOptions.SetSccToolsOption(SccToolsOptionsEnum, Object) 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.

This method sets a specified source control option to the specified value.

public:
 int SetSccToolsOption(Microsoft::VisualStudio::Shell::Interop::SccToolsOptionsEnum sctoOptionToBeSet, System::Object ^ varValueToBeSet);

public:
 int SetSccToolsOption(Microsoft::VisualStudio::Shell::Interop::SccToolsOptionsEnum sctoOptionToBeSet, Platform::Object ^ varValueToBeSet);

int SetSccToolsOption(Microsoft::VisualStudio::Shell::Interop::SccToolsOptionsEnum sctoOptionToBeSet, winrt::Windows::Foundation::IInspectable const & varValueToBeSet);

public int SetSccToolsOption (Microsoft.VisualStudio.Shell.Interop.SccToolsOptionsEnum sctoOptionToBeSet, object varValueToBeSet);

abstract member SetSccToolsOption : Microsoft.VisualStudio.Shell.Interop.SccToolsOptionsEnum * obj -> int

Public Function SetSccToolsOption (sctoOptionToBeSet As SccToolsOptionsEnum, varValueToBeSet As Object) As Integer

Parameters

sctoOptionToBeSet: SccToolsOptionsEnum

[in] A value from the __SccToolsOptionsEnum enumeration.

varValueToBeSet: Object

[in] The value to set on the option (typically, this will be nonzero for true and zero for false, but other values are possible depending on the option). See the individual options in SccToolsOptionsEnum for the appropriate values to use.

Returns

Int32

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

Remarks

COM Signature

From ivsscctoolsoptions.idl

HRESULT SetSccToolsOption(  
   [in] SccToolsOptionsEnum sctoOptionToBeSet,  
   [in] VARIANT varValueToBeSet  
);

Only those options listed in the __SccToolsOptionsEnum enumeration can be set with this method.

Values can be read using the GetSccToolsOption method.

Applies to

Share via