DataConnectionProperties.GetKeyAsString Method

Formats a property key for placement in a connection string.

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Protected Overridable Function GetKeyAsString ( _
    key As String _
) As String

protected virtual string GetKeyAsString(
    string key
)

protected:
virtual String^ GetKeyAsString(
    String^ key
)

abstract GetKeyAsString : 
        key:string -> string 
override GetKeyAsString : 
        key:string -> string

protected function GetKeyAsString(
    key : String
) : String

Parameters

key
Type: System.String
The key value to format.

Return Value

Type: System.String
The value of the specified property key in a string format suitable for placement in a connection string.

Exceptions

Exception	Condition
ArgumentNullException	The key parameter is nulla null reference (Nothing in Visual Basic).

Remarks

If the key contains a key value separator character, it will be doubled.

.NET Framework Security

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.