DatabaseProvider.ConnectionStringArguments Property

Gets a collection that contains the collection of database connection arguments.

Namespace:  Microsoft.Web.Management.DatabaseManager
Assembly:  Microsoft.Web.Management.DatabaseManager (in Microsoft.Web.Management.DatabaseManager.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property ConnectionStringArguments As ICollection(Of ConnectionArgument)
'Usage
Dim instance As DatabaseProvider
Dim value As ICollection(Of ConnectionArgument)

value = instance.ConnectionStringArguments

public abstract ICollection<ConnectionArgument> ConnectionStringArguments { get; }

public:
virtual property ICollection<ConnectionArgument^>^ ConnectionStringArguments {
    ICollection<ConnectionArgument^>^ get () abstract;
}

abstract function get ConnectionStringArguments () : ICollection<ConnectionArgument>

Property Value

Type: System.Collections.Generic.ICollection<ConnectionArgument>
A read-only ICollection object that contains a ConnectionArgument collection.

Remarks

Your provider must implement the ConnectionStringArguments property in order to define the connection string arguments that your database provider requires.

Examples

The following code sample illustrates an example ConnectionStringArguments property that returns the connection string arguments for a Microsoft Access database provider.

    Public Overrides ReadOnly Property ConnectionStringArguments() _
            As System.Collections.Generic.ICollection( _
            Of Microsoft.Web.Management.DatabaseManager.ConnectionArgument)

        Get
            Dim argList As LinkedList(Of ConnectionArgument) = New LinkedList(Of ConnectionArgument)
            Dim provider As ConnectionArgument = New ConnectionArgument
            provider.Name = "Provider"
            provider.DefaultValue = "Microsoft.Jet.OLEDB.4.0"
            argList.AddLast(provider)
            Dim database As ConnectionArgument = New ConnectionArgument
            database.Name = "Data Source"
            database.DefaultValue = "*.mdb"
            database.IsRequired = True
            argList.AddLast(database)
            Dim password As ConnectionArgument = New ConnectionArgument
            password.Name = "Jet OLEDB:Database Password"
            password.DefaultValue = ""
            password.IsRequired = False
            password.IsPassword = True
            argList.AddLast(password)
            Return argList
        End Get

    End Property

        public override ICollection<ConnectionArgument> ConnectionStringArguments
        {
            get
            {
                LinkedList<ConnectionArgument> argList = new LinkedList<ConnectionArgument>();

                ConnectionArgument provider = new ConnectionArgument();
                provider.Name = "Provider";
                provider.DefaultValue = "Microsoft.Jet.OLEDB.4.0";
                argList.AddLast(provider);

                ConnectionArgument database = new ConnectionArgument();
                database.Name = "Data Source";
                database.DefaultValue = "*.mdb";
                database.IsRequired = true;
                argList.AddLast(database);

                ConnectionArgument password = new ConnectionArgument();
                password.Name = "Jet OLEDB:Database Password";
                password.DefaultValue = "";
                password.IsRequired = false;
                password.IsPassword = true;
                argList.AddLast(password);

                return argList;
            }
        }

Permissions

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

DatabaseProvider Class

Microsoft.Web.Management.DatabaseManager Namespace