CreateDataReader(String,String,Int32) Method

Creates a DataReader by sending the sql to the Connection and build an IDataReader.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function CreateDataReader( _ 
   ByVal sql As String, _ 
   ByVal database As String, _ 
   ByVal commandTimeout As Integer _ 
) As IDataReader

public static IDataReader CreateDataReader( 
   string sql,
   string database,
   int commandTimeout 
)

Parameters

sql: The SQL specifiyng the data to return in the DataReader
database: Name of the MS Access database to get the data from (I.e. "Access.mdb" in /Database directory). Ignored if solution is running MS SQL-Server
commandTimeout: The wait time before terminating the attempt to execute a command and generating an error. The default is 30 seconds.

Return Value

Datareader instance - OleDBReader for Access solutions and SqlDbReader for SQl-Server based solutions.

Remarks

The underlying connection will close itself after the reader is closed and disposed.

Example

Create a DataReaderCreate a DataReader

C#
Visual Basic

namespace Dynamicweb.Examples.CSharp
{
    class DatabaseCreateDataReader
    {

        public void DataReaderSample()
        {
            //Create a DataReader on the default database
            using (var myDr = Database.CreateDataReader("SELECT TOP 10 * FROM Page"))
            {
                while (myDr.Read())
                {
                    var pageId = Input.FormatInteger(myDr["PageID"]);
                }
            }

            //Create a DataReader on alternate database
            using (var myDr = Database.CreateDataReader("SELECT TOP 10 * FROM AccessUser", "Access.mdb"))
            {
                while (myDr.Read())
                {
                    var pageId = Input.FormatInteger(myDr["AccessUserID"]);
                }
            }

        }

    }
}

Public Class DatabaseCreateDataReader

    Public Sub DataReaderSample()

        'Create a DataReader on the default database
        Using myDr As IDataReader = Database.CreateDataReader("SELECT TOP 10 * FROM Page")
            Do While myDr.Read
                Dim pageId As Integer = Input.FormatInteger(myDr.Item("PageID"))
            Loop
        End Using

        'Create a DataReader on alternate database
        Using myDr As IDataReader = Database.CreateDataReader("SELECT TOP 10 * FROM AccessUser", "Access.mdb")
            Do While myDr.Read
                Dim pageId As Integer = Input.FormatInteger(myDr.Item("AccessUserID"))
            Loop
        End Using

    End Sub

End Class

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

Database Class
Database Members
Overload List