SQLProcedures 関数

適合 性
導入版:ODBC 1.0 規格準拠:ODBC

まとめ
SQLProcedures は特定のデータソースに保存されたプロシージャ名のリストを返します。 プロシージャ とは、 実行可能なオブジェクトや、入力および出力パラメータを使って呼び出せる名前付きエンティティを表す一般的な用語です。 手続きの詳細については、「 手順」をご覧ください。

Syntax

  
SQLRETURN SQLProcedures(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      CatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      SchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      ProcName,  
     SQLSMALLINT    NameLength3);  

引数

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

CatalogName
[入力]手術カタログ。 ドライバが一部のテーブルにはカタログをサポートしているが、他のテーブルではサポートしない場合(例えば異なるDBMSからデータを取得する場合など)、空文字列(「」)はカタログを持たないテーブルを示します。 CatalogNameは 文字列検索パターンを含めません。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 CatalogName は識別子として扱われ、その大文字は重要ではありません。 もしSQL_FALSEであれば、 カタログ名 は通常の引数となります。文字通りに扱われており、そのケースは重要です。 詳細については、「カタログ関数の引数」を参照してください。

NameLength1
[入力]*カタログ名の文字数。

SchemaName
[入力]プロシージャスキーマ名の文字列検索パターン。 ドライバがあるプロシージャにはスキーマがサポートされているが、他のプロシージャには対応しない場合(例えば異なるDBMSからデータを取得する場合など)、空文字列("")はスキーマを持たないプロシージャを示します。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 SchemaName は識別子として扱われ、その大文字は重要ではありません。 SQL_FALSEの場合、 SchemaName はパターンの値の引数となります。文字通りに扱われており、そのケースは重要です。

NameLength2
[入力]*SchemaNameの文字数。

ProcName
[入力]プロシージャ名の文字列検索パターン。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 ProcName は識別子として扱われ、その大文字は重要ではありません。 SQL_FALSEの場合、 ProcName はパターン値の引数です。文字通りに扱われており、そのケースは重要です。

NameLength3
[入力]*ProcNameの文字数。

返品

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

Diagnostics

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

Comments

SQLProcedures は、要求範囲内のすべての手続きを一覧化します。 ユーザーはこれらの手順を実行する権限を持つ場合もあれば、持たない場合もあります。 アクセシビリティを確認するために、アプリケーションは SQLGetInfo を呼び出してSQL_ACCESSIBLE_PROCEDURES情報値を確認できます。 そうでなければ、ユーザーが実行できないプロシージャを選択した場合に対応できる必要があります。 この情報がどのように利用されるかについては 、「手続き」を参照してください。

SQLProcedures は、PROCEDURE_CAT、PROCEDURE_SCHEMA、PROCEDURE_NAME順に並べた標準結果セットとして結果を返します。

以下の列はODBC 3*.x*に改名されています。 カラム名の変更は後方互換性には影響しません。なぜならアプリケーションはカラム番号でバインドするからです。

PROCEDURE_CAT、PROCEDURE_SCHEM、PROCEDURE_NAMEの各カラムの実際の長さを決定するために、アプリケーションはSQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、SQL_MAX_PROCEDURE_NAME_LENのオプションで SQLGetInfo を呼び出すことができます。

次の表に、結果セットの列を示します。 8列(PROCEDURE_TYPE)以降の追加列はドライバーによって定義可能です。 アプリケーションは、明示的な順序位置を指定するのではなく、結果セットの末尾からカウントダウンすることでドライバー固有の列にアクセスするべきです。 詳細については、「 カタログ関数によって返されるデータ」を参照してください。

SchemaNameとProcNameの引数は検索パターンを受け入れます。 有効な検索パターンの詳細については、「 パターン値引数」を参照してください。

コード例

手順 の呼び出しを参照してください。

関連関数

こちらもご覧ください

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