dotConnect for FreshBooks Documentation
Devart.Common Namespace / DbCommandBase Class / ExecutePageReader Method
One of the System.Data.CommandBehavior values.
Zero-based ordinal of row that result set starts with.
Quantity of rows in result set.
Example

ExecutePageReader Method
Returns a specific subset of rows when paging through the results of a query.
Syntax
'Declaration
 
Public Function ExecutePageReader( _
   ByVal behavior As CommandBehavior, _
   ByVal startRecord As Integer, _
   ByVal maxRecords As Integer _
) As DbDataReader
 

Parameters

behavior
One of the System.Data.CommandBehavior values.
startRecord
Zero-based ordinal of row that result set starts with.
maxRecords
Quantity of rows in result set.

Return Value

Remarks

Use method ExecutePageReader when you want to retrieve not the whole dataset but some part of it that begins with given row number and has certain quantity of rows. This is especially useful when working with large amounts of data.

If you want to retrieve all data in a dataset, use System.Data.Common.DbCommandBase.ExecuteReader() instead.

Example
The example below shows how to retrieve a part of a table. If this function is called with parameters startRecord=2 and maxRecords=3, it returns 3 rows: second, third, and fourth.
public void ExecutePaged(FreshBooksConnection freshbooksConnection, int StartRow, int PageLength)
{
  FreshBooksCommand freshbooksCommand = new FreshBooksCommand("SELECT Id, FirstName, LastName FROM Client", freshbooksConnection);
  freshbooksConnection.Open();
  FreshBooksDataReader freshbooksReader = freshbooksCommand.ExecutePageReader(System.Data.CommandBehavior.Default,StartRow,PageLength);
  try
  {
    while (freshbooksReader.Read())
    {
        Console.WriteLine(freshbooksReader.GetString(0) + ", " + freshbooksReader.GetString(1) + ", " + freshbooksReader.GetString(2));
    }
  }
  finally
  {
    freshbooksReader.Close();
    freshbooksConnection.Close();
  }
}
Public Sub ExecutePaged(ByVal freshbooksConnection As FreshBooksConnection, ByVal StartRow As Integer, ByVal PageLength As Integer)
  Dim freshbooksCommand As New FreshBooksCommand("SELECT Id, FirstName, LastName FROM Client", freshbooksConnection)
  freshbooksConnection.Open()
  Dim freshbooksReader As FreshBooksDataReader = freshbooksCommand.ExecutePageReader(System.Data.CommandBehavior.Default, StartRow, PageLength)
  Try
    While freshbooksReader.Read()
      Console.WriteLine(freshbooksReader.GetString(0) + ", " _
      + freshbooksReader.GetString(1) + ", " _
      + freshbooksReader.GetString(2))
    End While
  Finally
    freshbooksReader.Close()
    freshbooksConnection.Close()
  End Try
End Sub
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also