SQLGetDescRec 関数

適合 性
導入バージョン:ODBC 3.0 規格準拠:ISO 92

Summary
SQLGetDescRec は、ディスクリプタレコードの複数のフィールドの現在設定や値を返します。 返されるフィールドは、カラムやパラメータデータの名称、データ型、および格納場所を表しています。

構文

  
SQLRETURN SQLGetDescRec(  
      SQLHDESC        DescriptorHandle,  
      SQLSMALLINT     RecNumber,  
      SQLCHAR *       Name,  
      SQLSMALLINT     BufferLength,  
      SQLSMALLINT *   StringLengthPtr,  
      SQLSMALLINT *   TypePtr,  
      SQLSMALLINT *   SubTypePtr,  
      SQLLEN *        LengthPtr,  
      SQLSMALLINT *   PrecisionPtr,  
      SQLSMALLINT *   ScalePtr,  
      SQLSMALLINT *   NullablePtr);  

引数

DescriptorHandle
[入力]ディスクリプターハンドル。

RecNumber
[入力]アプリケーションが情報を求めるディスクリプタレコードを示します。 ディスクリプタレコードは1から番号付けされ、レコード番号0がブックマークレコードです。 RecNumberの引数はSQL_DESC_COUNTの値以下でなければなりません。 RecNumberがSQL_DESC_COUNT以下で行に列やパラメータのデータが含まれていない場合、SQLGetDescRecを呼び出しるとフィールドのデフォルト値を返します。 (詳細は SQLSetDescFieldの「ディスクリプタフィールドの初期化」を参照してください。)

氏名
[出力]ディスクリプタレコードのSQL_DESC_NAMEフィールドを返すためのバッファへのポインタです。

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

BufferLength
[入力]*名前 バッファの長さ(文字数)です。

StringLengthPtr
[出力]*Name バッファで返せるデータ文字数(null-termination文字を除く)を返すためのバッファへのポインタです。 文字数が BufferLength以上の場合、*Name のデータはnull終端文字の長さを引いた BufferLength に切り詰められ、ドライバによってnull終端処理されます。

タイププトル
[出力]ディスクリプタレコードのSQL_DESC_TYPEフィールドの値を返すためのバッファへのポインタです。

サブタイププトル
[出力]型がSQL_DATETIMEまたはSQL_INTERVALのレコードの場合、これはSQL_DESC_DATETIME_INTERVAL_CODEフィールドの値を返すためのバッファへのポインタです。

LengthPtr
[出力]ディスクリプタレコードのSQL_DESC_OCTET_LENGTHフィールドの値を返すバッファへのポインタです。

プレシジョンPtr
[出力]ディスクリプタレコードのSQL_DESC_PRECISIONフィールドの値を返すためのバッファへのポインタです。

ScalePtr
[出力]記述子レコードのSQL_DESC_SCALEフィールドの値を返すためのバッファへのポインタです。

NullablePtr
[出力]ディスクリプタレコードのSQL_DESC_NULLABLEフィールドの値を返すためのバッファへのポインタです。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、SQL_NO_DATA、SQL_INVALID_HANDLE。

RecNumberが現在のディスクリプタレコード数より多い場合、SQL_NO_DATAが返されます。

SQL_NO_DATAは、 DescriptorHandle がIRDハンドルで文が準備または実行状態にあるが、開いているカーソルがない場合に返されます。

Diagnostics

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

Comments

アプリケーションは SQLGetDescRec を呼び出して、単一の列またはパラメータに対して以下のディスクリプタフィールドの値を取得できます。

• SQL_DESC_NAME

• SQL_DESC_TYPE

• SQL_DESC_DATETIME_INTERVAL_CODE(タイプがSQL_DATETIMEまたはSQL_INTERVALのレコード用)

• SQL_DESC_OCTET_LENGTH

• SQL_DESC_PRECISION

• SQL_DESC_SCALE

• SQL_DESC_NULLABLE

SQLGetDescRec はヘッダーフィールドの値を取得しません。

アプリケーションは、フィールドに対応する引数をヌルポインタに設定することで、フィールドの設定の返還を防ぐことができます。

アプリケーションが特定の記述子タイプに対して未定義のフィールドの値を取得するために SQLGetDescRec を呼び出すと、関数はSQL_SUCCESSを返しますが、そのフィールドの値は未定義です。 例えば、APDやARDのSQL_DESC_NAMEまたはSQL_DESC_NULLABLEフィールドに対して SQLGetDescréc を呼び出すと、フィールドの値はSQL_SUCCESS返されますが、その値は定義されていません。

アプリケーションが SQLGetDescRec を呼び出して、特定のディスクリプタタイプで定義されているがデフォルト値がなく、まだ設定されていないフィールドの値を取得すると、関数はSQL_SUCCESSを返しますが、そのフィールドの値は未定義です。 詳細については、 SQLSetDescFieldの「ディスクリプタフィールドの初期化」をご覧ください。

フィールドの値は SQLGetDescFieldを呼び出しることで個別に取得することも可能です。 ディスクリプタヘッダーやレコード内のフィールドの説明については、 SQLSetDescFieldを参照してください。 記述子の詳細については、「記述子」を参照してください。

関連関数

関連するコンテンツ

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