SQLDescribeParam 関数

準拠
導入されたバージョン: ODBC 1.0 Standards Compliance: ODBC

まとめ
SQLDescribeParam は、準備された SQL ステートメントに関連付けられているパラメーター マーカーの説明を返します。 この情報は、IPD のフィールドでも使用できます。

構文

  
SQLRETURN SQLDescribeParam(  
      SQLHSTMT        StatementHandle,  
      SQLUSMALLINT    ParameterNumber,  
      SQLSMALLINT *   DataTypePtr,  
      SQLULEN *       ParameterSizePtr,  
      SQLSMALLINT *   DecimalDigitsPtr,  
      SQLSMALLINT *   NullablePtr);  

引数

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

ParameterNumber
[入力]パラメーター マーカー番号は、1 から始まるパラメーターの順序を増やして順番に並べ替えています。

DataTypePtr
[出力]パラメーターの SQL データ型を返すバッファーへのポインター。 この値は、IPD の SQL_DESC_CONCISE_TYPE レコード フィールドから読み取られます。 これは、「付録 D: データ型」の「SQL データ型」セクションの値のいずれか、またはドライバー固有の SQL データ型になります。

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が返されます。 (SQL_INTEGERは、ODBC 3 でブックマークが使用されている場合に返されます。x アプリケーションが ODBC 2 で動作しています。x ドライバーまたは ODBC 2。ODBC 3 を使用する x アプリケーション。x ドライバー。)

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

ParameterSizePtr
[出力]データ ソースで定義されている対応するパラメーター マーカーの列または式のサイズを文字で返すバッファーへのポインター。 列サイズの詳細については、「列サイズ、 10 進数、転送オクテットの長さ、および表示サイズ」を参照してください。

DecimalDigitsPtr
[出力]データ ソースで定義されている対応するパラメーターの列または式の 10 進数の桁数を返すバッファーへのポインター。 10 進数の詳細については、「列サイズ、 10 進数、転送オクテットの長さ、および表示サイズ」を参照してください。

NullablePtr
[出力]パラメーターが NULL 値を許可するかどうかを示す値を返すバッファーへのポインター。 この値は、IPD の 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。

診断

SQLDescribeParam がSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、関連付けられている SQLSTATE 値を取得するには、SQL_HANDLE_STMTの HandleType と StatementHandle のハンドルを使用して SQLGetDiagRec を呼び出します。 次の表に、SQLDescribeParam によって通常返される SQLSTATE 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。"(DM)" という表記は、ドライバー マネージャーによって返される SQLSTATE の説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

パラメーター マーカーには、SQL ステートメントに表示される順序で、パラメーターの順序が 1 から始まる順に番号が付けられます。

SQLDescribeParam は、SQL ステートメント内のパラメーターの型 (入力、入力/出力、または出力) を返しません。 プロシージャの呼び出しを除き、SQL ステートメント内のすべてのパラメーターは入力パラメーターです。 プロシージャの呼び出しで各パラメーターの型を決定するために、アプリケーションは SQLProcedureColumns を呼び出 します。

詳細については、「パラメーターの記述」を参照してください。

コード例

次の例では、ユーザーに SQL ステートメントの入力を求め、そのステートメントを準備します。 次に、SQLNumParams を呼び出して、ステートメントにパラメーターが含まれているかどうかを判断します。 ステートメントにパラメーターが含まれている場合は、SQLDescribeParam を呼び出してそれらのパラメーターを記述し、SQLBindParameter を呼び出してバインドします。 最後に、パラメーターの値をユーザーに求め、ステートメントを実行します。

SQLCHAR       Statement[100];  
SQLSMALLINT   NumParams, i, DataType, DecimalDigits, Nullable;  
SQLUINTEGER   ParamSize;  
SQLHSTMT      hstmt;  
  
// Prompt the user for a SQL statement and prepare it.  
GetSQLStatement(Statement);  
SQLPrepare(hstmt, Statement, SQL_NTS);  
  
// Check to see if there are any parameters. If so, process them.  
SQLNumParams(hstmt, &NumParams);  
if (NumParams) {  
   // Allocate memory for three arrays. The first holds pointers to buffers in which  
   // each parameter value will be stored in character form. The second contains the  
   // length of each buffer. The third contains the length/indicator value for each  
   // parameter.  
   SQLPOINTER * PtrArray = (SQLPOINTER *) malloc(NumParams * sizeof(SQLPOINTER));  
   SQLINTEGER * BufferLenArray = (SQLINTEGER *) malloc(NumParams * sizeof(SQLINTEGER));  
   SQLINTEGER * LenOrIndArray = (SQLINTEGER *) malloc(NumParams * sizeof(SQLINTEGER));  
  
   for (i = 0; i < NumParams; i++) {  
   // Describe the parameter.  
   SQLDescribeParam(hstmt, i + 1, &DataType, &ParamSize, &DecimalDigits, &Nullable);  
  
   // Call a helper function to allocate a buffer in which to store the parameter  
   // value in character form. The function determines the size of the buffer from  
   // the SQL data type and parameter size returned by SQLDescribeParam and returns  
   // a pointer to the buffer and the length of the buffer.  
   AllocParamBuffer(DataType, ParamSize, &PtrArray[i], &BufferLenArray[i]);  
  
   // Bind the memory to the parameter. Assume that we only have input parameters.  
   SQLBindParameter(hstmt, i + 1, SQL_PARAM_INPUT, SQL_C_CHAR, DataType, ParamSize,  
         DecimalDigits, PtrArray[i], BufferLenArray[i],  
         &LenOrIndArray[i]);  
  
   // Prompt the user for the value of the parameter and store it in the memory  
   // allocated earlier. For simplicity, this function does not check the value  
   // against the information returned by SQLDescribeParam. Instead, the driver does  
   // this when the statement is executed.  
   GetParamValue(PtrArray[i], BufferLenArray[i], &LenOrIndArray[i]);  
   }  
}  
  
// Execute the statement.  
SQLExecute(hstmt);  
  
// Process the statement further, such as retrieving results (if any) and closing the  
// cursor (if any). Code not shown.  
  
// Free the memory allocated for each parameter and the memory allocated for the arrays  
// of pointers, buffer lengths, and length/indicator values.  
for (i = 0; i < NumParams; i++) free(PtrArray[i]);  
free(PtrArray);  
free(BufferLenArray);  
free(LenOrIndArray);  

関連する関数

参照

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