IVsSccToolsOptions.GetSccToolsOption Method

Retrieves the value associated with the specified source control option.

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

Syntax

'Declaration
Function GetSccToolsOption ( _
    sctoOptionToBeSet As SccToolsOptionsEnum, _
    <OutAttribute> ByRef pvarValueToGet As Object _
) As Integer
int GetSccToolsOption(
    SccToolsOptionsEnum sctoOptionToBeSet,
    out Object pvarValueToGet
)
int GetSccToolsOption(
    [InAttribute] SccToolsOptionsEnum sctoOptionToBeSet, 
    [OutAttribute] Object^% pvarValueToGet
)
abstract GetSccToolsOption : 
        sctoOptionToBeSet:SccToolsOptionsEnum * 
        pvarValueToGet:Object byref -> int 
function GetSccToolsOption(
    sctoOptionToBeSet : SccToolsOptionsEnum, 
    pvarValueToGet : Object
) : int

Parameters

  • pvarValueToGet
    Type: System.Object%
    [out] Returns the value associated with the specified option.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From ivsscctoolsoptions.idl

HRESULT GetSccToolsOption(
   [in] SccToolsOptionsEnum sctoOptionToBeSet,
   [out,retval] VARIANT *pvarValueToGet
);

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

Values can be set using the SetSccToolsOption method.

.NET Framework Security

See Also

Reference

IVsSccToolsOptions Interface

Microsoft.VisualStudio.Shell.Interop Namespace