BatchSearchResult

Contains results of a batch search.

Description

This object is returned by the searchBatches method. It describes the result of the search, including the total number of batches matched, the number being returned, and an array of BatchStatus objects

Properties

Type	Name	Description
integer	BatchesMatched	Total number of batches matched
integer	BatchesReturned	Number of batches returned in this result set
integer	StartIndex	The starting index used (defaults to 0)
integer	Limit	The max number batches to return in each result set.
BatchStatus	Batches	An array BatchStatus objects for the matched batches

Places Used

• searchBatches
• searchBatchesCount

Examples

.NET VB

    Dim result As newtek.BatchSearchResult = New newtek.BatchSearchResult
            result = client.searchBatches(token, search, matchAll, start, limit, sort)
            MsgBox(result.BatchesMatched)

.NET C

    newtek.BatchSearchResult result = new newtek.BatchSearchResult();

                try
                {
                    result = client.searchBatches(token, search, matchAll, start, limit, sort);

                    MessageBox.Show(string.Concat(result.BatchesMatched));

                }