dotConnect Universal 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

In This Topic
    ExecutePageReader Method
    In This Topic
    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
    public DbDataReader ExecutePageReader( 
       CommandBehavior behavior,
       int startRecord,
       int maxRecords
    )

    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 Devart.Common.DbDataReader 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 Devart.Common.DbCommand.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(MySqlConnection myConnection, int StartRow, int PageLength)
    {
      MySqlCommand myCommand = new MySqlCommand("SELECT * FROM Test.Dept", myConnection);
      myConnection.Open();
      MySqlDataReader myReader = myCommand.ExecutePageReader(System.Data.CommandBehavior.Default,StartRow,PageLength);
      try
      {
        while (myReader.Read())
        {
          Console.WriteLine(myReader.GetInt32(0) + ", " + myReader.GetString(1) + ", " + myReader.GetString(2));
        }
      }
      finally
      {
        myReader.Close();
        myConnection.Close();
      }
    }
    Public Sub ExecutePaged(ByVal myConnection As MySqlConnection, ByVal StartRow As Integer, ByVal PageLength As Integer)
      Dim myCommand As New MySqlCommand("SELECT * FROM Test.Dept", myConnection)
      myConnection.Open()
      Dim myReader As MySqlDataReader = myCommand.ExecutePageReader(System.Data.CommandBehavior.Default, StartRow, PageLength)
      Try
        While myReader.Read()
          Console.WriteLine(myReader.GetInt32(0).ToString() + ", " _
          + myReader.GetString(1) + ", " _
          + myReader.GetString(2))
        End While
      Finally
        myReader.Close()
        myConnection.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