ホーム › System.ApplicationInstallationAndServicing › ActivateActCtx

ActivateActCtx

関数

アクティベーションコンテキストを現在のスレッドで有効化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL ActivateActCtx(
    HANDLE hActCtx,   // optional
    UINT_PTR* lpCookie
);

パラメーター

名前	型	方向	説明
hActCtx	HANDLE	inoutoptional	アクティブにするアクティブ化コンテキストに関する情報を含む ACTCTX 構造体へのハンドルです。
lpCookie	UINT_PTR*	out	特定のアクティブ化されたアクティブ化コンテキストを一意に識別するクッキーとして機能する ULONG_PTR へのポインターです。

戻り値の型: BOOL

公式ドキュメント

ActivateActCtx 関数は、指定されたアクティブ化コンテキストをアクティブにします。

戻り値

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

この関数は、 GetLastError を呼び出すことで取得できるエラーを設定します。例については、 Retrieving the Last-Error Code を参照してください。エラーコードの完全な一覧については、 System Error Codes を参照してください。

解説(Remarks)

lpCookie パラメーターは、後で DeactivateActCtx に渡されます。DeactivateActCtx は、 ActivateActCtx と DeactivateActCtx の呼び出しの対応を検証し、適切なアクティブ化コンテキストが非アクティブ化されることを保証します。これは、アクティブ化コンテキストの非アクティブ化がアクティブ化とは逆の順序で行われる必要があるためです。

アクティブ化コンテキストのアクティブ化は、アクティブ化コンテキストをアクティブ化コンテキストのスタックにプッシュすることとして理解できます。この関数を通じてアクティブにしたアクティブ化コンテキストは、呼び出した任意の side-by-side API について、DLL、ウィンドウクラス、COM サーバー、タイプライブラリ、ミューテックスへのすべてのバインドをリダイレクトします。

アクティブ化コンテキストスタックの最上位の項目は、現在のスレッドのアクティブな既定のアクティブ化コンテキストです。null のアクティブ化コンテキストハンドルがスタックにプッシュされてアクティブ化されると、元のマニフェストの既定の設定が、スタックのそれより下にあるすべてのアクティブ化コンテキストを上書きします。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL ActivateActCtx(
    HANDLE hActCtx,   // optional
    UINT_PTR* lpCookie
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ActivateActCtx(
    IntPtr hActCtx,   // HANDLE optional, in/out
    out UIntPtr lpCookie   // UINT_PTR* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ActivateActCtx(
    hActCtx As IntPtr,   ' HANDLE optional, in/out
    <Out> ByRef lpCookie As UIntPtr   ' UINT_PTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hActCtx : HANDLE optional, in/out
' lpCookie : UINT_PTR* out
Declare PtrSafe Function ActivateActCtx Lib "kernel32" ( _
    ByVal hActCtx As LongPtr, _
    ByRef lpCookie As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ActivateActCtx = ctypes.windll.kernel32.ActivateActCtx
ActivateActCtx.restype = wintypes.BOOL
ActivateActCtx.argtypes = [
    wintypes.HANDLE,  # hActCtx : HANDLE optional, in/out
    ctypes.POINTER(ctypes.c_size_t),  # lpCookie : UINT_PTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ActivateActCtx = Fiddle::Function.new(
  lib['ActivateActCtx'],
  [
    Fiddle::TYPE_VOIDP,  # hActCtx : HANDLE optional, in/out
    Fiddle::TYPE_VOIDP,  # lpCookie : UINT_PTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn ActivateActCtx(
        hActCtx: *mut core::ffi::c_void,  // HANDLE optional, in/out
        lpCookie: *mut usize  // UINT_PTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool ActivateActCtx(IntPtr hActCtx, out UIntPtr lpCookie);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ActivateActCtx' -Namespace Win32 -PassThru
# $api::ActivateActCtx(hActCtx, lpCookie)

#uselib "KERNEL32.dll"
#func global ActivateActCtx "ActivateActCtx" sptr, sptr
; ActivateActCtx hActCtx, varptr(lpCookie)   ; 戻り値は stat
; hActCtx : HANDLE optional, in/out -> "sptr"
; lpCookie : UINT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global ActivateActCtx "ActivateActCtx" sptr, var
; res = ActivateActCtx(hActCtx, lpCookie)
; hActCtx : HANDLE optional, in/out -> "sptr"
; lpCookie : UINT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global ActivateActCtx "ActivateActCtx" sptr, sptr
; res = ActivateActCtx(hActCtx, varptr(lpCookie))
; hActCtx : HANDLE optional, in/out -> "sptr"
; lpCookie : UINT_PTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。