OleDbEnumerator.GetRootEnumerator Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns an OleDbDataReader that contains information about the currently installed OLE DB providers, without requiring an instance of the OleDbEnumerator class.

Namespace:   System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)

public static OleDbDataReader GetRootEnumerator()

Return Value

Type: System.Data.OleDb.OleDbDataReader

Returns a OleDbDataReader that contains information about the visible OLE DB providers.

Exception Condition
InvalidCastException

The provider does not support ISourcesRowset.

OleDbException

Exception has occurred in the underlying provider.

The reader returned by this method contains the following columns, all of which contain strings:

Column Ordinal

Column

Description

0

SOURCES_NAME

The invariant name of the native OLEDB data source or enumerator.

1

SOURCES_PARSENAME

A human-readable name that can be converted to a moniker using the native COM interface IParseDisplayName. Corresponds to the SOURCES_PARSENAME column returned by the native OLE DB sources rowset.

2

SOURCES_DESCRIPTION

Description of the native OLE DB data source. Corresponds to the SOURCES_DESCRIPTION column returned by the native OLE DB sources rowset.

3

SOURCES_TYPE

One of the following enumeration members: Binder (0), DataSource_MDP (1), DataSource_TDP (2), Enumerator (3). These correspond to the values returned in the SOURCES_TYPE column of the native OLE DB sources rowset.

4

SOURCES_ISPARENT

Applicable to enumerators only. If true, indicates that the entry applies to the same enumerator on which GetSourcesRowset was called, implying that it is also included in the sub-enumeration. Corresponds to the SOURCES_ISPARENT column of the native OLE DB sources rowset

5

SOURCES_CLSID

A human-readable name, that can be converted to a moniker using the native COM interface IParseDisplayName. Corresponds to the SOURCES_CLSID column returned by the native OLE DB sources rowset.

The following console application retrieves information about all the visible OLE DB providers and displays the information in the console window.

using System;
using System.Data;
using System.Data.OleDb;

class Program
{
 static void Main()
 {
   OleDbDataReader reader = OleDbEnumerator.GetRootEnumerator();

   DisplayData(reader);

   Console.WriteLine("Press any key to continue.");
   Console.ReadKey();
 }

 static void DisplayData(OleDbDataReader reader)
 {
   while (reader.Read())
   {
     for (int i = 0; i < reader.FieldCount; i++)
     {
       Console.WriteLine("{0} = {1}",
        reader.GetName(i), reader.GetValue(i));
     }
     Console.WriteLine("==================================");
   }
 }
}

.NET Framework
Available since 2.0
Return to top
Show: