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()
'Usage
Dim instance As VersionControlServer 
Dim itemSpecs As ItemSpec()
Dim queryWorkspaceName As String 
Dim queryUserName As String 
Dim includeDownloadInfo As Boolean 
Dim returnValue As PendingSet()

returnValue = instance.QueryPendingSets(itemSpecs, _
    queryWorkspaceName, queryUserName, _
    includeDownloadInfo)
public PendingSet[] QueryPendingSets(
    ItemSpec[] itemSpecs,
    string queryWorkspaceName,
    string queryUserName,
    bool includeDownloadInfo
)
public:
array<PendingSet^>^ QueryPendingSets(
    array<ItemSpec^>^ itemSpecs, 
    String^ queryWorkspaceName, 
    String^ queryUserName, 
    bool includeDownloadInfo
)
public function QueryPendingSets(
    itemSpecs : ItemSpec[], 
    queryWorkspaceName : String, 
    queryUserName : String, 
    includeDownloadInfo : boolean
) : PendingSet[]

Parameters

  • queryWorkspaceName
    Type: System.String

    The workspace name that may be null.

  • queryUserName
    Type: System.String

    The user name that may be null. queryUserName is the workspace owner if the workspace name is not null.

  • includeDownloadInfo
    Type: System.Boolean

    true to tell the server to include the information that is required to download the files.

Return Value

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

Remarks

Only set includeDownloadInfo to true if you want to download the files by using the returned objects. The call will be faster and require less bandwidth when this parameter is set to false. The overloaded methods set includeDownloadInfo to false.

.NET Framework Security

See Also

Reference

VersionControlServer Class

VersionControlServer Members

QueryPendingSets Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace