AdoDataConnectionEscapeIdentifier Method

Escapes an identifier, e.g., a table or field name, using the common delimiter for the connected AdoDataConnection database type or the standard ANSI escaping delimiter, i.e., double-quotes, based on the useAnsiQuotes flag.

Namespace: GSF.Data
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public string EscapeIdentifier(
	string identifier,
	bool useAnsiQuotes = false
)

Public Function EscapeIdentifier ( 
	identifier As String,
	Optional useAnsiQuotes As Boolean = false
) As String

public:
String^ EscapeIdentifier(
	String^ identifier, 
	bool useAnsiQuotes = false
)

member EscapeIdentifier : 
        identifier : string * 
        ?useAnsiQuotes : bool 
(* Defaults:
        let _useAnsiQuotes = defaultArg useAnsiQuotes false
*)
-> string

function EscapeIdentifier(identifier, useAnsiQuotes);

View Source

Parameters

identifier String: Field name to escape.
useAnsiQuotes Boolean (Optional): Force use of double-quote for identifier delimiter, per SQL-99 standard, regardless of database type.

Return Value

String
Escaped identifier name.

Exceptions

Exception	Condition
ArgumentException	identifier value cannot be null, empty or whitespace.

Reference

AdoDataConnection Class

GSF.Data Namespace