## Tcl9.0.3/Tk9.0.3 Documentation > TDBC Package C API, version 1.1.13 > Tdbc_Init

### Tcl/Tk Applications | Tcl Commands | Tk Commands | [incr Tcl] Package Commands | SQLite3 Package Commands | TDBC Package Commands | tdbc::mysql Package Commands | tdbc::odbc Package Commands | tdbc::postgres Package Commands | tdbc::sqlite3 Package Commands | Thread Package Commands | Tcl C API | Tk C API | [incr Tcl] Package C API | TDBC Package C API

  NAME
    Tdbc_Init, Tdbc_MapSqlState, Tdbc_TokenizeSql — C procedures to facilitate writing TDBC drivers
  構文 SYNOPSIS
  引数 ARGUMENTS
    Tcl_Interp *interp (入出力in/out)
    const char *state (入力in)
    const char *sqlcode (入力in)
  説明 DESCRIPTION
  TOKENS
  SEE ALSO
  KEYWORDS
  著作権 COPYRIGHT

### NAME

Tdbc_Init, Tdbc_MapSqlState, Tdbc_TokenizeSql — C procedures to facilitate writing TDBC drivers

### 構文 SYNOPSIS

#include <tdbc.h>
int
Tdbc_Init(interp)
Tcl_Obj *
Tdbc_TokenizeSql(interp, sqlcode)
const char *
Tdbc_MapSqlState(state)

### 引数 ARGUMENTS

Tcl_Interp *interp (入出力in/out)
  解釈実行機能への指示子｡　　　　 Pointer to a Tcl interpreter.

const char *state (入力in)
  基礎データ不都合からの 'SQL 宣言' を含む文字列への指示子｡　　　　 Pointer to a character string containing a 'SQL state' from a database error.

const char *sqlcode (入力in)
  SQL 宣言 を含む文字列への指示子｡　　　　 Pointer to a character string containing a SQL statement.

### 説明 DESCRIPTION

TDBC 外部函数は TDBC駆動譜の記述を簡素化する幾つかの C 言語手続函数を提供する｡ それらは､ SQL 命令文を語彙解析する手続函数､及び､ 置換すべき変数の位置を定める手続函数､及び､ SQL 命令文を受入れ､解釈実行機能の不都合情報為の不都合の級を返す手続函数を含む｡　　　　　　　 The TDBC library provides several C procedures that simplify writing a TDBC driver. They include a procedure that tokenizes a SQL statement, locating variables to be substituted, and a procedure that accepts a SQL state and returns an error class for the interpreter error information.

Tdbc_Init は､その他のどの TDBC 呼出しにも先行して起動されなくてはならない｡ それは Tcl 解釈実行機能の位置を受入れ､TDBC 外部函数を積込む為の手配をする｡ もし Tcl 外部函数が成功裡に積込まれると､TCL_OK を返し､ そうでない場合は､TCL_ERROR を返す｡ 解釈実行機能の結果は不都合伝言文を含む｡ Tdbc_Init must be invoked prior to any other TDBC call. It accepts a pointer to a Tcl interpreter, and arranges to load the TDBC library. It returns TCL_OK if the Tcl library was loaded successfully, and TCL_ERROR otherwise. If TCL_ERROR is returned, the interpreter's result contains the error message.

Tdbc_TokenizeSql は Tcl 解釈実行機能への指示子と､一つ或はそれ以上の SQL 命令文を含む文字列への指示子を受入れる｡それは SQL 命令文を語彙解析し､命令文を組上げられる解析語彙のリストを含む Tcl_Obj への指示子を返す｡ 解析語彙を互いに鎖状に連結して元の SQL 命令文を得ることができる｡ 返された Tcl_Obj は参照番号の零を有する｡ 呼出し者は必要に応じて参照番号を管理する責務がある｡返される解析語彙のリストに何があるかに就いての記述は下の TOKENS を参照されたい｡ Tdbc_TokenizeSql accepts a pointer to a Tcl interpreter, and a pointer to a character string containing one or more SQL statements. It tokenizes the SQL statements, and returns a pointer to a Tcl_Obj that contains a list of the tokens that make up the statement. Concatenating the tokens together will yield the original SQL code. The returned Tcl_Obj has a reference count of zero. The caller is responsible for managing the reference count as needed. See TOKENS below for a description of what may be in the returned list of tokens.

Tdbc_MapSqlState は文字列へのポインターを受入れる､その文字列は､通常は長さが五語で､基礎データ不都合の結果の 'SQL 状態state' である｡ 又､TDBC 駆動譜中の不都合の為の不都合符号を構築する際に不都合階級としての組込みに適切な文字列を返す｡ (慣例では､不都合符号は少なくとも四つの要素を有するリストである: "TDBC errorClass sqlstate driverName details...". ) Tdbc_MapSqlState accepts a pointer to a string, usually five characters long, that is the 'SQL state' that resulted from a database error. It returns a character string that is suitable for inclusion as the error class when constructing the error code for an error in a TDBC driver. (By convention, the error code is a list having at least four elements: "TDBC errorClass sqlstate driverName details...".)

### TOKENS

Tdbc_TokenizeSql から返ったそれぞれの解析語彙は次の内の一つであるかもしれない:　　　　　　 Each token returned from Tdbc_TokenizeSql may be one of the following:

1. 束縛変数､それは次の文字の内の一つで始まる ':', '@', or '$'｡ 文字列の残りは変数の名前であり､英数字文字と下線文字で構成される｡(先頭の文字は非数字｡)　　　　　　 A bound variable, which begins with one of the characters ':', '@', or '$'. The remainder of the string is the variable name and will consist of alphanumeric characters and underscores. (The leading character will be be non-numeric.)

2. 二つの SQL 命令文を分離する セミコロン｡　　　　　　 A semicolon that separates two SQL statements.

3. それ以外の SQL 命令文｡ 語彙解析機能は SQL を解析しようと試みない; それは単に束縛変数(引用や注釈の内部に現れる､似ている文字列から区別する)と､命令文の区切りと､認識する｡　　　　　　 Something else in a SQL statement. The tokenizer does not attempt to parse SQL; it merely identifies bound variables (distinguishing them from similar strings appearing inside quotes or comments) and statement delimiters.

### SEE ALSO

tdbc, tdbc::mapSqlState, tdbc::tokenize

### KEYWORDS

TDBC, SQL, database, tokenize

### 著作権 COPYRIGHT

Copyright (c) 2009 by Kevin B. Kenny.
Copyright © 2009 by Kevin B. Kenny.