IVsSccProjectEnlistmentChoice.GetEnlistmentChoice Method
Determines whether an enlistment choice should be given to the user each time a project is checked out from source control.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)
Syntax
'Declaration
Function GetEnlistmentChoice ( _
<OutAttribute> pvscecEnlistmentChoice As VSSCCENLISTMENTCHOICE() _
) As Integer
int GetEnlistmentChoice(
VSSCCENLISTMENTCHOICE[] pvscecEnlistmentChoice
)
int GetEnlistmentChoice(
[OutAttribute] array<VSSCCENLISTMENTCHOICE>^ pvscecEnlistmentChoice
)
abstract GetEnlistmentChoice :
pvscecEnlistmentChoice:VSSCCENLISTMENTCHOICE[] byref -> int
function GetEnlistmentChoice(
pvscecEnlistmentChoice : VSSCCENLISTMENTCHOICE[]
) : int
Parameters
pvscecEnlistmentChoice
Type: array<Microsoft.VisualStudio.Shell.Interop.VSSCCENLISTMENTCHOICE[][out] Returns a value from the VSSCCENLISTMENTCHOICE enumeration indicating whether an enlistment choice is required, optional, or not supported.
Return Value
Type: 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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.