16.10.6 SQLProcedures,SQLProceduresW
- 〈この項の構成〉
(1) 機能
特定のデータソースに格納されたプロシジャの一覧を返します。SQL文の結果セットの形式で出力します。
ただし,プロシジャをサポートしていないため,検索結果セットの行数は常に0になります。
(2) 形式
-
SQLProceduresの場合
SQLRETURN SQLProcedures ( SQLHSTMT StatementHandle, /* In */ SQLCHAR * CatalogName, /* In */ SQLSMALLINT NameLength1, /* In */ SQLCHAR * SchemaName, /* In */ SQLSMALLINT NameLength2, /* In */ SQLCHAR * ProcName, /* In */ SQLSMALLINT NameLength3 /* In */ )
-
SQLProceduresWの場合
SQLRETURN SQLProceduresW ( SQLHSTMT StatementHandle, /* In */ SQLWCHAR * CatalogName, /* In */ SQLSMALLINT NameLength1, /* In */ SQLWCHAR * SchemaName, /* In */ SQLSMALLINT NameLength2, /* In */ SQLWCHAR * ProcName, /* In */ SQLSMALLINT NameLength3 /* In */ )
(3) 引数
- StatementHandle:
-
ステートメントハンドルを指定します。
この関数を実行する前にSQLAllocHandleの*OutputHandlePtrで出力された値を指定します。
- CatalogName:
-
プロシジャのカタログ名を指定します。
- NameLength1:
-
*CatalogNameの長さ※を指定します。
- SchemaName:
-
プロシジャのスキーマ名に対するパターン文字列を指定します。
- NameLength2:
-
*SchemaNameの長さ※を指定します。
- ProcName:
-
プロシジャ名に対するパターン文字列を指定します。
- NameLength3:
-
*ProcNameの長さ※を指定します。
- 注※
-
長さの単位は,SQLProceduresの場合はバイト長,SQLProceduresWの場合は文字数となります。
(4) 戻り値
SQL_SUCCESS,SQL_ERROR,またはSQL_INVALID_HANDLEが返されます。
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
SQLSTATE |
説明 |
備考 |
返却 |
---|---|---|---|
01000 |
一般警告 |
− |
× |
08S01 |
通信リンク失敗 |
× |
|
24000 |
無効なカーソル状態 |
カーソルがオープンしている状態のときに実行されました。 |
○ |
40001 |
直列化の失敗 |
− |
× |
40003 |
ステートメントの完了が不明 |
× |
|
HY000 |
一般エラー |
× |
|
HY001 |
メモリ割り当てエラー |
○ |
|
HY008 |
動作がキャンセルされた |
× |
|
HY009 |
NULLポインタの不正使用 |
× |
|
HY010 |
関数シーケンスエラー |
○ |
|
HY013 |
メモリ管理エラー |
× |
|
HY090 |
無効な文字列長または無効なバッファ長 |
× |
|
HY117 |
接続がサスペンド中 |
× |
|
HYC00 |
オプション機能は実装されていない |
× |
|
HYT00 |
タイムアウト終了 |
× |
|
HYT01 |
接続タイムアウト終了 |
× |
|
IM001 |
ドライバはこの関数をサポートしていない |
× |
|
IM017 |
非同期ポーリングが不正 |
× |
|
IM018 |
非同期実行が未完了 |
× |
- (凡例)
-
○:HADB ODBCドライバが返すことがあるSQLSTATEです。
×:HADB ODBCドライバが返さないSQLSTATEです。
−:なし。