ExecutePageReader Method

In This Topic

Syntax
Remarks
Example
See Also

Returns a specific subset of rows when paging through the results of a query.

Syntax

Visual Basic
C#

public DbDataReader ExecutePageReader( 
   CommandBehavior behavior,
   int startRecord,
   int maxRecords
)

'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

A DbDataReaderBase object.

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.

csharp

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();
  }
}

Visual Basic

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

Reference

DbCommandBase Class
DbCommandBase Members

Send Feedback