developer:soap-1.6:objects:batchsearchresult

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:objects:batchsearchresult [2012/08/04 11:33] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​
  
 +====== BatchSearchResult ======
 +
 +Contains results of a batch search.
 +
 +===== Description =====
 +
 +This object is returned by the [[developer:​soap:​methods:​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 =====
 +
 +  * [[..:​methods:​searchBatches]]
 +  * [[..:​methods:​searchBatchesCount]] ​
 +
 +===== Examples =====
 +==== .NET VB ====
 +<code vb>
 +Dim result As usaepay.BatchSearchResult = New usaepay.BatchSearchResult
 +        result = client.searchBatches(token,​ search, matchAll, start, limit, sort)
 +        MsgBox(result.BatchesMatched)
 +</​code>​
 +==== .NET C# ====
 +<code c>
 +usaepay.BatchSearchResult result = new usaepay.BatchSearchResult();​
 + 
 +            try
 +            {
 +                result = client.searchBatches(token,​ search, matchAll, start, limit, sort);
 + 
 +                MessageBox.Show(string.Concat(result.BatchesMatched));​
 + 
 +            }
 +
 +</​code>​
 +
 +===== Change History =====
 +
 +^ Version ^ Change ^
 +| [[developer:​soap-1.2:​objects:​batchsearchresult|1.2]] | Method added prior to soap-1.2 |
developer/soap-1.6/objects/batchsearchresult.txt ยท Last modified: 2012/08/04 11:33 by tem

Page Tools