DbConnectionStringBuilder.AppendKeyValuePair Method (StringBuilder, String, String, Boolean)

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

Provides an efficient and safe way to append a key and value to an existing StringBuilder object.

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

public static void AppendKeyValuePair (
	StringBuilder builder,
	string keyword,
	string value,
	bool useOdbcRules
)
public static void AppendKeyValuePair (
	StringBuilder builder, 
	String keyword, 
	String value, 
	boolean useOdbcRules
)
public static function AppendKeyValuePair (
	builder : StringBuilder, 
	keyword : String, 
	value : String, 
	useOdbcRules : boolean
)

Parameters

builder

The StringBuilder to which to add the key/value pair.

keyword

The key to be added.

value

The value for the supplied key.

useOdbcRules

true to use { to delimit fields, false to use quotation marks.

This method allows developers using a StringBuilder to create a collection of key/value pairs to be able to take advantage of the features included in the DbConnectionStringBuilder class when adding key/value pairs, without having to incur the overhead of creating and maintaining a DbConnectionStringBuilder instance. The AppendKeyValuePair method formats the key and value correctly and adds the new string to the supplied StringBuilder.

Although most data sources let you delimit fields by using quotation marks, ODBC does not--for ODBC connection strings, you must use curly braces ({). In order to have the DbConnectionStringBuilder use ODBC rules for delimiting fields, set the useOdbcRules parameter to true.

If some process has created a connection string, but now an application must perform a simple modification to that connection string, it might be more efficient to just add the key/value pair using a StringBuilder object. Instead of creating a new DbConnectionStringBuilder, developers can call the AppendKeyValuePair method, passing in a StringBuilder that contains the supplied connection string. The following procedure shows a simple example of this technique, using ODBC rules for quoting values.

public string AddPooling(string connectionString)
{
    StringBuilder builder = new StringBuilder(connectionString);
    DbConnectionStringBuilder.AppendKeyValuePair(builder, "Pooling", "true");
    return builder.ToString();


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
Show: