IVsSccToolsOptions.GetSccToolsOption(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.

Retrieves the value associated with the specified source control option.

public:
 int GetSccToolsOption(Microsoft::VisualStudio::Shell::Interop::SccToolsOptionsEnum sctoOptionToBeSet, [Runtime::InteropServices::Out] System::Object ^ % pvarValueToGet);

int GetSccToolsOption(Microsoft::VisualStudio::Shell::Interop::SccToolsOptionsEnum sctoOptionToBeSet, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & pvarValueToGet);

public int GetSccToolsOption (Microsoft.VisualStudio.Shell.Interop.SccToolsOptionsEnum sctoOptionToBeSet, out object pvarValueToGet);

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

Public Function GetSccToolsOption (sctoOptionToBeSet As SccToolsOptionsEnum, ByRef pvarValueToGet As Object) As Integer

Parameters

sctoOptionToBeSet: SccToolsOptionsEnum

[in] A value from the __SccToolsOptionsEnum enumeration.

pvarValueToGet: Object

[out] Returns the value associated with the specified option.

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

Applies to