Export (0) Print
Expand All

OleDbConnectionStringBuilder.OleDbServices Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the value to be passed for the OLE DB Services key within the connection string.

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

public int OleDbServices { get; set; 
/** @property */
public int get_OleDbServices ()

/** @property */
public void set_OleDbServices (int value)

public function get OleDbServices () : int

public function set OleDbServices (value : int)

Property Value

Returns the value corresponding to the OLE DB Services key within the connection string. By default, the value is -13.

The OLE DB Services key within the connection string defines a combination of values that let developers enable or disable OLE DB services. The property contains a bitwise combination of values, described in the OLE DB documentation. For more information about appropriate values for this property, see the OLE DB Programmer's Reference, in particular, "Overriding Provider Service Defaults." The default value for this property is -13. This corresponds to a request for resource pooling, automatic transaction enlistment, session-level aggregation, and no client cursor engine.

The following example works with the OleDbServices property in two ways. First, it assigns a value directly to the property, demonstrating the effect this action has on the resulting connection string. Then, the example clears the OleDbConnectionStringBuilder and assigns a complete connection string that contains a value for the OLE DB Services key. This step demonstrates that setting the value from the connection string modifies the OleDbServices property, as well.

using System.Data.OleDb;

class Program
{
    // These constants correspond to values in the 
    // OLE DB SDK. You can use these values to 
    // turn features on and off.
    private const int DBPROPVAL_OS_AGR_AFTERSESSION = 8;
    private const int DBPROPVAL_OS_AGR_RESOURCEPOOLING = 1;
    private const int DBPROPVAL_OS_AGR_TXNENLISTMENT = 2;
    private const int DBPROPVAL_OS_AGR_CLIENTCURSOR = 4;
    private const int DBPROPVAL_OS_ENABLEALL = -1;
    private const int DBPROPVAL_OS_DISABLEALL = 0;


    static void Main()
    {
        OleDbConnectionStringBuilder builder =
            new OleDbConnectionStringBuilder();
        // Turn on all services except resource pooling.
        builder.OleDbServices =
            DBPROPVAL_OS_ENABLEALL &
            ~DBPROPVAL_OS_AGR_RESOURCEPOOLING;

        builder.Provider = "sqloledb";
        builder.DataSource = "(local)";
        builder["Initial Catalog"] = "AdventureWorks";
        builder["Integrated Security"] = "SSPI";

        // Store the connection string.
        string savedConnectionString = builder.ConnectionString;
        Console.WriteLine(savedConnectionString);

        // Reset the object. This resets all the properties to their
        // default values.
        builder.Clear();

        // Investigate the OleDbServices property before
        // and after assigning a connection string value.
        Console.WriteLine("Default : " + builder.OleDbServices);
        builder.ConnectionString = savedConnectionString;
        Console.WriteLine("Modified: " + builder.OleDbServices);

        Console.WriteLine("Press Enter to finish.");
        Console.ReadLine();
    


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft