SQLRowCount 関数

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

まとめ
SQLRowCount は、 UPDATE、 INSERT、または DELETE 文の影響を受ける行数、 SQLBulkOperationsのSQL_ADD、SQL_UPDATE_BY_BOOKMARK、SQL_DELETE_BY_BOOKMARK操作、または SQLSetPosのSQL_UPDATEまたはSQL_DELETE操作によって影響を受ける行数を返します。

構文

  
SQLRETURN SQLRowCount(  
      SQLHSTMT   StatementHandle,  
      SQLLEN *   RowCountPtr);  

引数

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

RowCountPtr
[出力]行数を返すバッファーを指します。 UPDATE、INSERT、DELETE文、SQLBulkOperationsのSQL_ADD、SQL_UPDATE_BY_BOOKMARK、SQL_DELETE_BY_BOOKMARK操作、SQLSetPosのSQL_UPDATEまたはSQL_DELETE操作については、*RowCountPtrで返される値は、リクエストに影響を受ける行数、影響を受ける行数が利用できない場合は -1 となります。

SQLExecute、SQLExecDirect、SQLBulkOperations、SQLSetPos、または SQLMoreResults が呼び出されると、診断データ構造のSQL_DIAG_ROW_COUNT フィールドが行数に設定され、行数は実装に依存する方法でキャッシュされます。 SQLRowCount は、キャッシュされた行数の値を返します。 キャッシュされた行数の値は、ステートメント ハンドルが準備済みまたは割り当て済み状態に戻されるか、ステートメントが再実行されるか、SQLCloseCursor が呼び出されるまで有効です。 SQL_DIAG_ROW_COUNT フィールドが設定されてから関数が呼び出された場合、 SQLRowCount によって返される値は、SQL_DIAG_ROW_COUNT フィールドが任意の関数呼び出しによって 0 にリセットされるため、SQL_DIAG_ROW_COUNT フィールドの値と異なる場合があることに注意してください。

その他のステートメントや関数の場合、ドライバーは *RowCountPtr で返される値を定義できます。 たとえば、一部のデータ ソースは、行をフェッチする前に、 SELECT ステートメントまたはカタログ関数によって返される行の数を返すことができます。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

診断

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

Comments

もし文ハンドル上で最後に実行されたSQL文がUPDATE、INSERT、またはDELETE文でなかったり、前回のSQLBulkOperations呼び出しのOperation引数がSQL_ADD、SQL_UPDATE_BY_BOOKMARK、SQL_DELETE_BY_BOOKMARKでなかったり、前回のSQLSetPos呼び出しのOperation引数がSQL_UPDATEやSQL_DELETEでなかった場合、 *RowCountPtrの値はドライバーによって定義されます。 詳細については、「影響を受ける行の数の決定」を参照してください。

関連する関数

参照

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