Partager via


IVsSccToolsOptions.SetSccToolsOption(SccToolsOptionsEnum, Object) Method

Definition

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

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