QueryEditFiles Method (Boolean, String[])

Ask SCC if file can be checked out. SCC will check the file out if allowed to do so. The user may be prompted (depending on settings) before checkout.

Namespace:  Microsoft.VisualStudio.Data.Tools.Package.UI
Assembly:  Microsoft.VisualStudio.Data.Tools.Package (in Microsoft.VisualStudio.Data.Tools.Package.dll)

Syntax

'Declaration
Public Shared Function QueryEditFiles ( _
    <OutAttribute> ByRef userCanceled As Boolean, _
    ParamArray files As String() _
) As Boolean
'Usage
Dim userCanceled As Boolean
Dim files As String()
Dim returnValue As Boolean

returnValue = DataPackage.QueryEditFiles(userCanceled, _
    files)
public static bool QueryEditFiles(
    out bool userCanceled,
    params string[] files
)
public:
static bool QueryEditFiles(
    [OutAttribute] bool% userCanceled, 
    ... array<String^>^ files
)
static member QueryEditFiles : 
        userCanceled:bool byref * 
        files:string[] -> bool 
public static function QueryEditFiles(
    userCanceled : boolean, 
    ... files : String[]
) : boolean

Parameters

  • userCanceled
    Type: System..::..Boolean%
    Return flag indicating if the user canceled the checkout.

Return Value

Type: System..::..Boolean
True if the files were checked out, false otherwise.

See Also

Reference

DataPackage Class

QueryEditFiles Overload

Microsoft.VisualStudio.Data.Tools.Package.UI Namespace