IVsSccProjectEnlistmentChoice.GetEnlistmentChoice 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.11.40262

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.

Determines whether an enlistment choice should be given to the user each time a project is checked out from source control.

public:
 int GetEnlistmentChoice(cli::array <Microsoft::VisualStudio::Shell::Interop::VSSCCENLISTMENTCHOICE> ^ pvscecEnlistmentChoice);

public:
 int GetEnlistmentChoice(Platform::Array <Microsoft::VisualStudio::Shell::Interop::VSSCCENLISTMENTCHOICE> ^ pvscecEnlistmentChoice);

int GetEnlistmentChoice(std::Array <Microsoft::VisualStudio::Shell::Interop::VSSCCENLISTMENTCHOICE> const & pvscecEnlistmentChoice);

public int GetEnlistmentChoice (Microsoft.VisualStudio.Shell.Interop.VSSCCENLISTMENTCHOICE[] pvscecEnlistmentChoice);

abstract member GetEnlistmentChoice : Microsoft.VisualStudio.Shell.Interop.VSSCCENLISTMENTCHOICE[] -> int

Public Function GetEnlistmentChoice (pvscecEnlistmentChoice As VSSCCENLISTMENTCHOICE()) As Integer

Parameters

pvscecEnlistmentChoice: VSSCCENLISTMENTCHOICE[]

[out] Returns a value from the VSSCCENLISTMENTCHOICE enumeration indicating whether an enlistment choice is required, optional, or not supported.

Returns

Int32

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

Remarks

COM Signature

From ivssccprojectenlistmentchoice.idl

HRESULT GetEnlistmentChoice(  
   [out, retval] VSSCCENLISTMENTCHOICE * pvscecEnlistmentChoice  
);

This method allows a project to specify one of the following:

It never requires a new enlistment when the project is checked out of source control.
The user should be given the choice of setting a new enlistment location.
It must ask the user for a new enlistment location each time the project is checked out.

Visual Studio supplies the dialog box that asks the user for the enlistment choice. The IVsSccProjectEnlistmentFactory interface is then called to give the user the option of browsing for the enlistment and/or editing the suggested enlistment (if they are allowed to change the suggested enlistment at all). Once the enlistment has been established, the IVsSccEnlistmentPathTranslation interface is used to translate between the enlistment path and the source control path.

Applies to

Share via