Share via


IVsSccToolsOptions.SetSccToolsOption Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function SetSccToolsOption ( _
    sctoOptionToBeSet As SccToolsOptionsEnum, _
    varValueToBeSet As Object _
) As Integer
int SetSccToolsOption(
    SccToolsOptionsEnum sctoOptionToBeSet,
    Object varValueToBeSet
)
int SetSccToolsOption(
    [InAttribute] SccToolsOptionsEnum sctoOptionToBeSet, 
    [InAttribute] Object^ varValueToBeSet
)
abstract SetSccToolsOption : 
        sctoOptionToBeSet:SccToolsOptionsEnum * 
        varValueToBeSet:Object -> int
function SetSccToolsOption(
    sctoOptionToBeSet : SccToolsOptionsEnum, 
    varValueToBeSet : Object
) : int

Parameters

  • varValueToBeSet
    Type: 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.

Return Value

Type: 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.

.NET Framework Security

See Also

Reference

IVsSccToolsOptions Interface

Microsoft.VisualStudio.Shell.Interop Namespace