JetGetInstanceInfo 関数
適用対象: Windows |Windows Server
JetGetInstanceInfo 関数
JetGetInstanceInfo 関数は、実行中のインスタンスに関する情報を取得します。
Windows XP: JetGetInstanceInfo は Windows XP で導入されています。
JET_ERR JET_API JetGetInstanceInfo(
__out unsigned long* pcInstanceInfo,
__out JET_INSTANCE_INFO** paInstanceInfo
);
パラメーター
pcInstanceInfo
paInstanceInfo に格納されている要素の数を受け取るバッファーへのポインター。
paInstanceInfo
構造体の配列の最初の要素のアドレスを受け取るバッファーへのポインター。
戻り値
この関数は、次のいずれかの戻りコードを 使用して、JET_ERR データ型を返します。 考えられる ESE エラーの詳細については、「 拡張ストレージ エンジン エラー と エラー処理パラメーター」を参照してください。
リターン コード |
説明 |
|---|---|
JET_errSuccess |
操作は正常に完了しました。 |
JET_errInvalidParameter |
指定されたパラメーターの 1 つに予期しない値が含まれていたか、別のパラメーターの値と組み合わせたときに意味のない値が含まれていました。 このエラーは、次の場合に JetGetInstanceInfo によって返されます。
|
JET_errOutOfMemory |
要求を処理するためのメモリが不足しています。 |
解説
データベース エンジンは、 JET_INSTANCE_INFO 構造体の配列を割り当てます。 呼び出し元は、 JetFreeBuffer を使用してこのメモリを解放する役割を担います。
アクティブなインスタンスがない場合、 JetGetInstanceInfo はJET_errSuccessを返し、 pcInstanceInfo は 0 の値を受け取ります。
要件
| 要件 | 値 |
|---|---|
Client |
Windows Vista または Windows XP が必要です。 |
[サーバー] |
Windows Server 2008 または Windows Server 2003 が必要です。 |
Header |
Esent.h で宣言されています。 |
Library |
ESENT.lib を使用します。 |
[DLL] |
ESENT.dllが必要です。 |
Unicode |
JetGetInstanceInfoW (Unicode) および JetGetInstanceInfoA (ANSI) として実装されます。 |