ExecutePageReader Method

In This Topic

Syntax
Remarks
Example
Requirements
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(QuickBooksConnection quickBooksConnection, int StartRow, int PageLength)
{
  QuickBooksCommand quickBooksCommand = new QuickBooksCommand("SELECT Id, DisplayName, Notes FROM Customer", quickBooksConnection);
  quickBooksConnection.Open();
  QuickBooksDataReader quickBooksReader = quickBooksCommand.ExecutePageReader(System.Data.CommandBehavior.Default,StartRow,PageLength);
  try
  {
    while (quickBooksReader.Read())
    {
        Console.WriteLine(quickBooksReader.GetString(0) + ", " + quickBooksReader.GetString(1) + ", " + quickBooksReader.GetString(2));
    }
  }
  finally
  {
    quickBooksReader.Close();
    quickBooksConnection.Close();
  }
}

Visual Basic

Public Sub ExecutePaged(ByVal quickBooksConnection As QuickBooksConnection, ByVal StartRow As Integer, ByVal PageLength As Integer)
  Dim quickBooksCommand As New QuickBooksCommand("SELECT Id, DisplayName, Notes FROM Customer", quickBooksConnection)
  quickBooksConnection.Open()
  Dim quickBooksReader As QuickBooksDataReader = quickBooksCommand.ExecutePageReader(System.Data.CommandBehavior.Default, StartRow, PageLength)
  Try
    While quickBooksReader.Read()
      Console.WriteLine(quickBooksReader.GetString(0) + ", " _
      + quickBooksReader.GetString(1) + ", " _
      + quickBooksReader.GetString(2))
    End While
  Finally
    quickBooksReader.Close()
    quickBooksConnection.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

Reference

DbCommandBase Class
DbCommandBase Members

Send Feedback