DeactivateActCtx 関数 (winbase.h)

  • [アーティクル]

DeactivateActCtx 関数は、指定された Cookie に対応するアクティブ化コンテキストを非アクティブ化します。

構文

BOOL DeactivateActCtx(
  [in] DWORD     dwFlags,
  [in] ULONG_PTR ulCookie
);

パラメーター

[in] dwFlags

非アクティブ化の実行方法を示すフラグ。

値 説明
0
 この値が設定され、 ulCookie パラメーターで指定された Cookie がアクティブ化スタックの上部フレームにある場合、アクティブ化コンテキストはスタックからポップされ、それによって非アクティブ化されます。

この値が設定され、 ulCookie パラメーターで指定された Cookie がアクティブ化スタックの最上位フレームにない場合、この関数はスタックを検索して Cookie を検索します。

Cookie が見つかった場合は、STATUS_SXS_EARLY_DEACTIVATION例外がスローされます。

Cookie が見つからない場合は、STATUS_SXS_INVALID_DEACTIVATION例外がスローされます。

この値は、ほとんどの場合に指定する必要があります。
DEACTIVATE_ACTCTX_FLAG_FORCE_EARLY_DEACTIVATION
 この値が設定され、 ulCookie パラメーターで指定された Cookie がアクティブ化スタックの一番上のフレームにある場合、関数はERROR_INVALID_PARAMETERエラー コードを返します。 このコードを取得するには、GetLastError を呼び出します。

この値が設定されていて、Cookie がアクティブ化スタックにない場合は、STATUS_SXS_INVALID_DEACTIVATION例外がスローされます。

この値が設定され、Cookie がアクティブ化スタックの下位フレームにある場合、Cookie が含まれるフレームまでのフレームがすべてスタックからポップされます。

[in] ulCookie

ActivateActCtx の呼び出しに渡されたULONG_PTR。 この値は、特定のアクティブ化されたアクティブ化コンテキストを識別するための Cookie として使用されます。

戻り値

関数が成功すると、 TRUE が返されます。 それ以外の場合は、 FALSE を返します。

この関数は 、GetLastError を呼び出すことによって取得できるエラーを設定します。 例については、「 Last-Error コードの取得」を参照してください。 エラー コードの完全な一覧については、「 システム エラー コード」を参照してください。

解説

アクティブ化コンテキストの非アクティブ化は、アクティブ化の逆の順序で行う必要があります。 これは、スタックからアクティブ化コンテキストをポップしていると理解できます。

要件

   
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

ActivateActCtx