SQLDescribeCol 関数

適合 性
導入されたバージョン: ODBC 1.0 標準コンプライアンス: ISO 92

Summary
SQLDescribeCol は結果セット内の1列に対して、列名、型、列サイズ、小数点数、nullabilityなどの記述子を返します。 この情報はIRDの分野でも利用可能です。

構文

  
SQLRETURN SQLDescribeCol(  
      SQLHSTMT       StatementHandle,  
      SQLUSMALLINT   ColumnNumber,  
      SQLCHAR *      ColumnName,  
      SQLSMALLINT    BufferLength,  
      SQLSMALLINT *  NameLengthPtr,  
      SQLSMALLINT *  DataTypePtr,  
      SQLULEN *      ColumnSizePtr,  
      SQLSMALLINT *  DecimalDigitsPtr,  
      SQLSMALLINT *  NullablePtr);  

引数

StatementHandle
[入力]ステートメント ハンドル。

列番号
[入力]結果データの列数は、列順に順番に並び、1から始まる。 ColumnNumberの引数は、ブックマークの列を表すために0に設定することもできます。

ColumnName
[出力]列名を返すためのnull終端バッファへのポインタ。 この値はIRDのSQL_DESC_NAMEフィールドから読み取られます。 列名が未定か、列名が判定できない場合、ドライバーは空の文字列を返します。

ColumnNameがNULLの場合、NameLengthPtr はColumnNameが指すバッファ内で返せる文字数(文字データのnull終端文字を除く)を返します。

BufferLength
[入力]*ColumnName バッファの長さ(文字数)。

NameLengthPtr
[出力]*ColumnNameで返せる文字数(null終端を除く)を返すバッファへのポインタ。 返せる文字数が BufferLength以上の場合、*ColumnName の列名は BufferLength からnull終端文字の長さを引いたものに切り詰められます。

DataTypePtr
[出力]カラムのSQLデータ型を返すためのバッファへのポインタ。 この値はIRDのSQL_DESC_CONCISE_TYPEフィールドから読み取られます。 これは SQLデータ型、またはドライバー固有のSQLデータ型のいずれかの値となります。 データ型が判別できない場合、ドライバーはSQL_UNKNOWN_TYPEを返します。

ODBC 3で。x、SQL_TYPE_DATE、SQL_TYPE_TIME、SQL_TYPE_TIMESTAMPは、それぞれ日付、時刻、またはタイムスタンプデータとして *DataTypePtr で返されます。ODBC 2に属しています。x、SQL_DATE、SQL_TIME、またはSQL_TIMESTAMPが返されます。 ドライバー マネージャーは、ODBC 2. 時に必要なマッピングを実行しますx アプリケーションが ODBC 3. で動作していますx ドライバーまたは ODBC 3.x アプリケーションは ODBC 2. で動作していますx ドライバー。

ColumnNumber が 0 (ブックマーク列の場合) に等しい場合、可変長ブックマークの*DataTypePtr でSQL_BINARYが返されます。 (ブックマークが ODBC 3. で使用されている場合、SQL_INTEGERが返されます。x ODBC 2. を使用するアプリケーションx ドライバーまたは ODBC 2.x ODBC 3. を使用するアプリケーションx ドライバー)。)

これらのデータ型の詳細については、付録Dの SQLデータ型 をご覧ください。 ドライバー固有の SQL データ型の詳細については、ドライバーのドキュメントを参照してください。

カラムサイズPtr
[出力]データソース上の列のサイズ(文字数)を返すためのバッファへのポインタ。 列サイズが判別できない場合、ドライバーは0を返します。 列サイズの詳細については、「付録 D: データ型」の「 列サイズ、10 進数、転送オクテット長、および表示サイズ を参照してください。

DecimalDigitsPtr
[出力]データソース上の列の小数点数を返すためのバッファへのポインタを表示します。 小数点の数が判別できない場合、または該当しない場合は、ドライバーは0を返します。 小数点数字の詳細については、付録Dのデータ型の「 列サイズ、小数点数字、転送オクテット長、表示サイズ 」をご覧ください。

NullablePtr
[出力]バッファへのポインタは、その列がNULL値を許容しているかどうかを示す値を返します。 この値はIRDのSQL_DESC_NULLABLEフィールドから読み取られます。 値は、次のいずれかになります。

SQL_NO_NULLS: この列はNULL値を許可していません。

SQL_NULLABLE:この列はNULLの値を許容します。

SQL_NULLABLE_UNKNOWN:ドライバーはその列がNULL値を許容しているかどうかを判断できません。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_STILL_EXECUTING、SQL_ERROR、またはSQL_INVALID_HANDLE。

Diagnostics

SQLDescribeColがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、SQLGetDiagRecを呼び出してHandleTypeをSQL_HANDLE_STMT、HandleをStatementHandleで呼び出すことで、関連するSQLSTATE値を取得できます。 以下の表は 、SQLDescribeCol が一般的に返すSQLSTATEの値と、それぞれをこの関数の文脈で説明しています。「(DM)」という表記は、ドライバーマネージャーが返すSQLstateの記述の前に記載されます。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

SQLDescribeColは、データソースが文ハンドルに関連付けられたSQL文を評価するタイミングに応じて、SQLPrepareまたはSQLExecuteが呼び出す際に、SQLPrepareまたはSQLExecuteが返す任意のSQLSTATEを返すことができます。

パフォーマンスの理由から、アプリケーションは文を実行する前に SQLDescribeCol を呼び出すべきではありません。

Comments

アプリケーションは通常、SQLPrepareへの呼び出しの後、SQLExecuteへの呼びかけの前後にSQLDescribeColを呼び出します。 アプリケーションはSQLExecDirectへの呼び出し後にSQLDescribeColを呼び出すこともできます。 詳細については、「メタデータの結果セット」を参照してください。

SQLDescribeCol は SELECT 文によって生成される列名、型、長さを取得します。 列が式の場合、*ColumnName は空文字列かドライバー定義の名前のいずれかです。

関連関数

関連するコンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル