OdbcConnectionStringBuilder Kelas

Definisi

Ruang nama:

System.Data.Odbc

Rakitan:

System.Data.Odbc.dll

Paket:

System.Data.Odbc v9.0.0-preview.4.24266.19

Sumber:

OdbcConnectionStringbuilder.cs

Menyediakan cara sederhana untuk membuat dan mengelola konten string koneksi yang digunakan oleh OdbcConnection kelas .

public ref class OdbcConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder

public sealed class OdbcConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

type OdbcConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class OdbcConnectionStringBuilder
Inherits DbConnectionStringBuilder

Warisan

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Contoh

Aplikasi konsol berikut membangun string koneksi untuk beberapa database ODBC. Pertama, contoh membuat string koneksi untuk database Microsoft Access. Kemudian membuat string koneksi untuk database IBM DB2. Contohnya juga mengurai string koneksi yang ada, dan menunjukkan berbagai cara memanipulasi konten string koneksi.

Catatan

Contoh ini mencakup kata sandi untuk menunjukkan cara OdbcConnectionStringBuilder kerja dengan string koneksi. Di aplikasi Anda, kami sarankan Anda menggunakan Autentikasi Windows. Jika Anda harus menggunakan kata sandi, jangan sertakan kata sandi yang dikodekan secara permanen di aplikasi Anda.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder();
        builder.Driver = "Microsoft Access Driver (*.mdb)";

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Dbq", "C:\\info.mdb");
        builder.Add("Uid", "Admin");
        builder.Add("Pwd", "pass!word1");

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Clear current values and reset known keys to their
        // default values.
        builder.Clear();

        // Pass the OdbcConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" +
            "hostname=SampleServerName;port=SamplePortNum;" +
            "protocol=TCPIP;uid=Admin;pwd=pass!word1";

        Console.WriteLine("protocol = "
            + builder["protocol"].ToString());
        Console.WriteLine();

        // Modify existing items.
        builder["uid"] = "NewUser";
        builder["pwd"] = "Pass@word2";

        // Call the Remove method to remove items from
        // the collection of key/value pairs.
        builder.Remove("port");

        // Note that calling Remove on a nonexistent item does not
        // throw an exception.
        builder.Remove("BadItem");
        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Setting the indexer adds the associated value, if
        // necessary.
        builder["NewKey"] = "newValue";
        Console.WriteLine(builder.ConnectionString);

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

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder()
    builder.Driver = "Microsoft Access Driver (*.mdb)"

    ' Call the Add method to explicitly add key/value
    ' pairs to the internal collection.
    builder.Add("Dbq", "C:\info.mdb")
    builder.Add("Uid", "Admin")
    builder.Add("Pwd", "pass!word1")

    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' Clear current values and reset known keys to their
    ' default values.
    builder.Clear()

    ' Pass the OdbcConnectionStringBuilder an existing 
    ' connection string, and you can retrieve and
    ' modify any of the elements.
    builder.ConnectionString = _
        "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" & _
        "hostname=SampleServerName;port=SamplePortNum;" & _
        "protocol=TCPIP;uid=Admin;pwd=pass!word1"

    Console.WriteLine("protocol = " & builder("protocol").ToString())
    Console.WriteLine()

    ' Modify existing items:
    builder("uid") = "NewUser"
    builder("pwd") = "Pass@word2"

    ' Call the Remove method to remove items from 
    ' the collection of key/value pairs.
    builder.Remove("port")

    ' Note that calling Remove on a nonexistent item does not
    ' throw an exception.
    builder.Remove("BadItem")
    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' The Item property is the default for the class, 
    ' and setting the Item property adds the value, if 
    ' necessary.
    builder("NewKey") = "newValue"
    Console.WriteLine(builder.ConnectionString)

    Console.WriteLine("Press Enter to finish.")
    Console.ReadLine()
  End Sub
End Module

Keterangan

Penyusun string koneksi memungkinkan pengembang secara terprogram membuat string koneksi yang benar secara sintaksis, dan mengurai dan membangun kembali string koneksi yang ada, menggunakan properti dan metode kelas. Penyusun string koneksi menyediakan properti yang sangat ditik sesuai dengan pasangan kunci/nilai yang diketahui yang diizinkan oleh koneksi ODBC, dan pengembang dapat menambahkan pasangan kunci/nilai arbitrer untuk nilai string koneksi lainnya.

Pengembang perlu membuat string koneksi sebagai bagian dari aplikasi dapat menggunakan OdbcConnectionStringBuilder kelas untuk membangun dan memodifikasi string koneksi. Kelas ini juga memudahkan untuk mengelola string koneksi yang disimpan dalam file konfigurasi aplikasi. OdbcConnectionStringBuilder melakukan pemeriksaan hanya untuk sekumpulan terbatas pasangan kunci/nilai yang diketahui. Oleh karena itu, kelas ini dapat digunakan untuk membuat string koneksi yang tidak valid. Tabel berikut mencantumkan kunci tertentu yang diketahui bersama dengan properti terkait dalam OdbcConnectionStringBuilder kelas , dan nilai defaultnya. Selain nilai spesifik ini, pengembang dapat menambahkan pasangan kunci/nilai apa pun ke koleksi yang terkandung dalam OdbcConnectionStringBuilder instans.

Kunci	Properti	Komentar	Nilai default
Driver	Driver	Pengembang tidak boleh menyertakan kurung kurawal di sekitar nama driver saat mereka mengatur Driver properti . OdbcConnectionStringBuilder Instans menambahkan kurung kurawal sesuai kebutuhan.	String kosong
DSN	Dsn		String kosong

Jika ada nilai (selain Driver nilai) dalam string koneksi berisi titik koma (;), nilai OdbcConnectionStringBuilder tersebut akan mengelilingi nilai dengan tanda kutip dalam string koneksi. Untuk menghindari masalah ini dengan Driver nilai yang sering berisi titik koma, OdbcConnectionStringBuilder kelas selalu mengelilingi nilai ini dengan kurung kurawal. Spesifikasi ODBC menunjukkan bahwa nilai driver yang berisi titik koma harus dikelilingi dengan kurung kurawal, dan kelas ini menanganinya untuk Anda.

Properti Item[] menangani upaya untuk menyisipkan kode berbahaya. Misalnya, kode berikut, menggunakan properti default Item[] (pengindeks, di C#) dengan benar keluar dari pasangan kunci/nilai berlapis.

Dim builder As _
 New System.Data.Odbc.OdbcConnectionStringBuilder
' Take advantage of the Driver property.
builder.Driver = "SQL Server"
builder("Server") = "MyServer;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)

System.Data.Odbc.OdbcConnectionStringBuilder builder =
  new System.Data.Odbc.OdbcConnectionStringBuilder();
// Take advantage of the Driver property.
builder.Driver = "SQL Server";
builder["Server"] = "MyServer;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);

Hasilnya adalah string koneksi berikut yang menangani nilai yang tidak valid dengan cara yang aman:

Driver={SQL Server};Server="MyServer;NewValue=Bad"

Konstruktor

OdbcConnectionStringBuilder()	Menginisialisasi instans baru kelas OdbcConnectionStringBuilder.
OdbcConnectionStringBuilder(String)	Menginisialisasi instans baru kelas OdbcConnectionStringBuilder. string koneksi yang disediakan menyediakan data untuk informasi koneksi internal instans.

Properti

BrowsableConnectionString	Mendapatkan atau menetapkan nilai yang menunjukkan apakah ConnectionString properti terlihat di perancang Visual Studio. (Diperoleh dari DbConnectionStringBuilder)
ConnectionString	Mendapatkan atau mengatur string koneksi yang terkait dengan DbConnectionStringBuilder. (Diperoleh dari DbConnectionStringBuilder)
Count	Mendapatkan jumlah kunci saat ini yang terkandung dalam ConnectionString properti . (Diperoleh dari DbConnectionStringBuilder)
Driver	Mendapatkan atau mengatur nama driver ODBC yang terkait dengan koneksi.
Dsn	Mendapatkan atau mengatur nama nama sumber data (DSN) yang terkait dengan koneksi.
IsFixedSize	Mendapatkan nilai yang menunjukkan apakah DbConnectionStringBuilder memiliki ukuran tetap. (Diperoleh dari DbConnectionStringBuilder)
IsReadOnly	Mendapatkan nilai yang menunjukkan apakah DbConnectionStringBuilder bersifat baca-saja. (Diperoleh dari DbConnectionStringBuilder)
Item[String]	Mendapatkan atau mengatur nilai yang terkait dengan kunci yang ditentukan. Di C#, properti ini adalah pengindeks.
Keys	ICollection Mendapatkan yang berisi kunci di OdbcConnectionStringBuilder.
Values	ICollection Mendapatkan yang berisi nilai dalam DbConnectionStringBuilder. (Diperoleh dari DbConnectionStringBuilder)

Metode

Add(String, Object)	Menambahkan entri dengan kunci dan nilai yang ditentukan ke DbConnectionStringBuilderdalam . (Diperoleh dari DbConnectionStringBuilder)
Clear()	Menghapus konten instans OdbcConnectionStringBuilder .
ClearPropertyDescriptors()	Menghapus kumpulan PropertyDescriptor objek pada yang terkait DbConnectionStringBuilder. (Diperoleh dari DbConnectionStringBuilder)
ContainsKey(String)	Menentukan apakah OdbcConnectionStringBuilder berisi kunci tertentu.
Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
EquivalentTo(DbConnectionStringBuilder)	Membandingkan informasi koneksi dalam objek ini DbConnectionStringBuilder dengan informasi koneksi dalam objek yang disediakan. (Diperoleh dari DbConnectionStringBuilder)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetProperties(Hashtable)	Mengisi yang disediakan Hashtable dengan informasi tentang semua properti ini DbConnectionStringBuilder. (Diperoleh dari DbConnectionStringBuilder)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
Remove(String)	Menghapus entri dengan kunci yang ditentukan dari OdbcConnectionStringBuilder instans.
ShouldSerialize(String)	Menunjukkan apakah kunci yang ditentukan ada dalam instans ini DbConnectionStringBuilder . (Diperoleh dari DbConnectionStringBuilder)
ToString()	Mengembalikan string koneksi yang terkait dengan iniDbConnectionStringBuilder. (Diperoleh dari DbConnectionStringBuilder)
TryGetValue(String, Object)	Mengambil nilai yang sesuai dengan kunci yang disediakan dari ini OdbcConnectionStringBuilder.

Implementasi Antarmuka Eksplisit

ICollection.CopyTo(Array, Int32)	Menyalin elemen ICollection ke Array, dimulai dari indeks tertentu Array . (Diperoleh dari DbConnectionStringBuilder)
ICollection.IsSynchronized	Mendapatkan nilai yang menunjukkan apakah akses ke disinkronkan ICollection (utas aman). (Diperoleh dari DbConnectionStringBuilder)
ICollection.SyncRoot	Mendapatkan objek yang dapat digunakan untuk menyinkronkan akses ke ICollection. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes()	Mengembalikan kumpulan atribut kustom untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName()	Mengembalikan nama kelas dari instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName()	Mengembalikan nama instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter()	Mengembalikan pengonversi jenis untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent()	Mengembalikan peristiwa default untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty()	Mengembalikan properti default untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type)	Mengembalikan editor dari jenis yang ditentukan untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents()	Mengembalikan peristiwa untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[])	Mengembalikan peristiwa untuk instans komponen ini menggunakan array atribut yang ditentukan sebagai filter. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties()	Mengembalikan properti untuk instans komponen ini. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[])	Mengembalikan properti untuk instans komponen ini menggunakan array atribut sebagai filter. (Diperoleh dari DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	Mengembalikan objek yang berisi properti yang dijelaskan oleh deskriptor properti yang ditentukan. (Diperoleh dari DbConnectionStringBuilder)
IDictionary.Add(Object, Object)	Menambahkan elemen dengan kunci dan nilai yang disediakan ke IDictionary objek . (Diperoleh dari DbConnectionStringBuilder)
IDictionary.Contains(Object)	Menentukan apakah IDictionary objek berisi elemen dengan kunci yang ditentukan. (Diperoleh dari DbConnectionStringBuilder)
IDictionary.GetEnumerator()	Mengembalikan IDictionaryEnumerator objek untuk IDictionary objek . (Diperoleh dari DbConnectionStringBuilder)
IDictionary.Item[Object]	Mendapatkan atau mengatur elemen dengan kunci yang ditentukan. (Diperoleh dari DbConnectionStringBuilder)
IDictionary.Remove(Object)	Menghapus elemen dengan kunci yang ditentukan dari IDictionary objek . (Diperoleh dari DbConnectionStringBuilder)
IEnumerable.GetEnumerator()	Mengembalikan enumerator yang berulang melalui koleksi. (Diperoleh dari DbConnectionStringBuilder)

Metode Ekstensi

Cast<TResult>(IEnumerable)	Mentransmisikan elemen dari ke IEnumerable jenis yang ditentukan.
OfType<TResult>(IEnumerable)	Memfilter elemen berdasarkan IEnumerable jenis yang ditentukan.
AsParallel(IEnumerable)	Mengaktifkan paralelisasi kueri.
AsQueryable(IEnumerable)	Mengonversi menjadi IEnumerableIQueryable.

Lihat juga

• Pembangun String Koneksi
• String Koneksi dalam ADO.NET