VersionControlServer.QueryPendingSets Method (array<ItemSpec , String, String, Boolean)

Gets the pending changes for the specified query.

Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

Syntax

'Declaration
Public Function QueryPendingSets ( _
    itemSpecs As ItemSpec(), _
    queryWorkspaceName As String, _
    queryUserName As String, _
    includeDownloadInfo As Boolean _
) As PendingSet()
public PendingSet[] QueryPendingSets(
    ItemSpec[] itemSpecs,
    string queryWorkspaceName,
    string queryUserName,
    bool includeDownloadInfo
)
public:
array<PendingSet^>^ QueryPendingSets(
    array<ItemSpec^>^ itemSpecs, 
    String^ queryWorkspaceName, 
    String^ queryUserName, 
    bool includeDownloadInfo
)
member QueryPendingSets : 
        itemSpecs:ItemSpec[] * 
        queryWorkspaceName:string * 
        queryUserName:string * 
        includeDownloadInfo:bool -> PendingSet[] 
public function QueryPendingSets(
    itemSpecs : ItemSpec[], 
    queryWorkspaceName : String, 
    queryUserName : String, 
    includeDownloadInfo : boolean
) : PendingSet[]

Parameters

  • queryWorkspaceName
    Type: System.String

    The workspace name (may be null).

  • queryUserName
    Type: System.String

    The user name (may be null), which is the workspace owner if the workspace name is not null.

  • includeDownloadInfo
    Type: System.Boolean

    True to get the information needed to download files. Specify false to save bandwidth if not necessary.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]
An array of PendingSet objects containing the pending changes for the specified server items.

Remarks

Only set includeDownloadInfo to true if you are going to be downloading the files using the objects that are returned. The call will be faster and require less bandwidth when includeDownloadInfo is false (default for overloads that don't specify it).

.NET Framework Security

See Also

Reference

VersionControlServer Class

QueryPendingSets Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace