JetSetSessionParameter 関数
適用対象: Windows |Windows Server
JetSetSessionParameter 関数は、データベース エンジンを構成します。
JET_ERR JET_API JetSetSessionParameter (
__in_opt JET_SESID sesid,
__in unsigned long sesparamid,
__in_read_bytes_opt_(cbParam) void* pvParam,
__in unsigned long cbParam
);
パラメーター
sesid
この呼び出しに使用するセッションを指定します。
指定すると、指定されたインスタンスは無視され、セッションに関連付けられているインスタンスが使用されます。
sesparamid
設定するセッション パラメーターの ID。
pvParam
このセッション パラメーターで設定するデータ。
cbParam
指定されたデータのサイズ。
戻り値
この関数は、次の表に示すリターン コードの 1 つを使用して、 JET_ERR データ型を返します。 拡張可能記憶域エンジン (ESE) の可能性のあるエラーの詳細については、「 拡張記憶域エンジンエラー と エラー処理パラメーター」を参照してください。
リターン コード |
説明 |
---|---|
JET_errSuccess |
操作は正常に完了しました。 |
JET_errAlreadyInitialized |
インスタンスは JetInit 関数の呼び出しを使用して初期化されているため、この操作は結果として実行できません。 これは、パラメーター値の変更がデータベース エンジンの状態に影響を与えなくなった後にシステム パラメーターを構成しようとした場合に発生する可能性があります。 |
JET_errClientRequestToStopJetService |
JetStopService 関数の呼び出しの結果、セッションに関連付けられているインスタンスのすべてのアクティビティが停止したため、操作を完了できません。 |
JET_errIndexTuplesInvalidLimits |
指定されたタプル インデックス パラメーターが無効でした。 このエラーは、 JET_paramIndexTuplesLengthMin、 JET_paramIndexTuplesLengthMax、または JET_paramIndexTuplesToIndexMax パラメーターが 無効な値に設定されている場合にのみ返されます。 これらのパラメーターの詳細については、「 インデックス パラメーター」を参照してください。 |
JET_errInitInProgress |
セッションに関連付けられているインスタンスが初期化されているため、操作を完了できません。 |
JET_errInstanceUnavailable |
セッションに関連付けられているインスタンスで、そのデータの整合性を保護するためにすべてのデータへのアクセスを取り消す必要がある致命的なエラーが発生したため、操作を完了できません。 |
JET_errInvalidParameter |
指定されたパラメーターの 1 つに予期しない値が含まれていたか、別のパラメーターの値と組み合わせたときに意味のない値が含まれていました。 これは、次の場合に発生する可能性があります。
|
JET_errInvalidPath |
指定されたファイル システム パスが無効です。 このエラーは、ファイル システム パスを表すシステム パラメーターを設定する場合にのみ 、JetSetSessionParameter によって返される可能性があります。 たとえば、 JET_paramSystemPath パラメーターは、このエラーを返す場合があります。 このパラメーターの詳細については、「 トランザクション ログ パラメーター」を参照してください。 |
JET_errNotInitialized |
セッションに関連付けられているインスタンスがまだ初期化されていないため、操作を完了できません。 |
JET_errRestoreInProgress |
セッションに関連付けられているインスタンスで復元操作が進行中のため、操作を完了できません。 |
JET_errTermInProgress |
セッションに関連付けられているインスタンスがシャットダウンされているため、操作を完了できません。 |
JET_errInvalidSesid |
セッション ハンドルが無効であるか、閉じられたセッションを参照しています。 このエラーは、すべての状況で返されるわけではありません。 ハンドルはベスト エフォートベースでのみ検証されます。 |
JET_errInvalidInstance |
インスタンス ハンドルが無効であるか、シャットダウンされたインスタンスを参照しています。 このエラーは、すべての状況で返されるわけではありません。 ハンドルはベスト エフォートベースでのみ検証されます。 |
成功すると、システム パラメーターは指定された値に設定されます。
失敗した場合、システム パラメーターの値は変更されません。
要件
要件 | 値 |
---|---|
Client |
Windows 8が必要です。 |
[サーバー] |
Windows Server 2012が必要です。 |
Header |
Esent.h で宣言されています。 |
Library |
ESENT.lib を使用します。 |
[DLL] |
ESENT.dllが必要です。 |
こちらもご覧ください
JET_API_PTR
JET_ERR
JET_INSTANCE
JET_SESID
JetCreateInstance
JetGetSystemParameter
JetInit
システム パラメーター