Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › DeactivateActCtx

DeactivateActCtx

関数
有効化したアクティベーションコンテキストを無効化する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL DeactivateActCtx(
    DWORD dwFlags,
    UINT_PTR ulCookie
);

パラメーター

名前方向説明
dwFlagsDWORDin

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

意味
0
この値が設定されており、ulCookie パラメーターで指定されたクッキーがアクティベーションスタックの最上位フレームにある場合、そのアクティベーションコンテキストはスタックからポップされ、非アクティブ化されます。

この値が設定されており、ulCookie パラメーターで指定されたクッキーがアクティベーションスタックの最上位フレームにない場合、この関数はスタックを下方向に検索してクッキーを探します。

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

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

ほとんどの場合、この値を指定してください。

DEACTIVATE_ACTCTX_FLAG_FORCE_EARLY_DEACTIVATION
この値が設定されており、ulCookie パラメーターで指定されたクッキーがアクティベーションスタックの最上位フレームにある場合、この関数は ERROR_INVALID_PARAMETER エラーコードを返します。このコードを取得するには GetLastError を呼び出します。

この値が設定されており、クッキーがアクティベーションスタック上にない場合は、STATUS_SXS_INVALID_DEACTIVATION 例外がスローされます。

この値が設定されており、クッキーがアクティベーションスタックの下位フレームにある場合は、そのクッキーが含まれるフレームまでのすべてのフレーム(当該フレームを含む)がスタックからポップされます。

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

BOOL DeactivateActCtx(
    DWORD dwFlags,
    UINT_PTR ulCookie
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool DeactivateActCtx(
    uint dwFlags,   // DWORD
    UIntPtr ulCookie   // UINT_PTR
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeactivateActCtx(
    dwFlags As UInteger,   ' DWORD
    ulCookie As UIntPtr   ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwFlags : DWORD
' ulCookie : UINT_PTR
Declare PtrSafe Function DeactivateActCtx Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal ulCookie As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeactivateActCtx = ctypes.windll.kernel32.DeactivateActCtx
DeactivateActCtx.restype = wintypes.BOOL
DeactivateActCtx.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # ulCookie : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
DeactivateActCtx = Fiddle::Function.new(
  lib['DeactivateActCtx'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # ulCookie : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn DeactivateActCtx(
        dwFlags: u32,  // DWORD
        ulCookie: usize  // UINT_PTR
    ) -> 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 DeactivateActCtx(uint dwFlags, UIntPtr ulCookie);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_DeactivateActCtx' -Namespace Win32 -PassThru
# $api::DeactivateActCtx(dwFlags, ulCookie)
#uselib "KERNEL32.dll"
#func global DeactivateActCtx "DeactivateActCtx" sptr, sptr
; DeactivateActCtx dwFlags, ulCookie   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; ulCookie : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global DeactivateActCtx "DeactivateActCtx" int, sptr
; res = DeactivateActCtx(dwFlags, ulCookie)
; dwFlags : DWORD -> "int"
; ulCookie : UINT_PTR -> "sptr"
; BOOL DeactivateActCtx(DWORD dwFlags, UINT_PTR ulCookie)
#uselib "KERNEL32.dll"
#cfunc global DeactivateActCtx "DeactivateActCtx" int, intptr
; res = DeactivateActCtx(dwFlags, ulCookie)
; dwFlags : DWORD -> "int"
; ulCookie : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procDeactivateActCtx = kernel32.NewProc("DeactivateActCtx")
)

// dwFlags (DWORD), ulCookie (UINT_PTR)
r1, _, err := procDeactivateActCtx.Call(
	uintptr(dwFlags),
	uintptr(ulCookie),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DeactivateActCtx(
  dwFlags: DWORD;   // DWORD
  ulCookie: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeactivateActCtx';
result := DllCall("KERNEL32\DeactivateActCtx"
    , "UInt", dwFlags   ; DWORD
    , "UPtr", ulCookie   ; UINT_PTR
    , "Int")   ; return: BOOL
●DeactivateActCtx(dwFlags, ulCookie) = DLL("KERNEL32.dll", "bool DeactivateActCtx(dword, int)")
# 呼び出し: DeactivateActCtx(dwFlags, ulCookie)
# dwFlags : DWORD -> "dword"
# ulCookie : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn DeactivateActCtx(
    dwFlags: u32, // DWORD
    ulCookie: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc DeactivateActCtx(
    dwFlags: uint32,  # DWORD
    ulCookie: uint  # UINT_PTR
): int32 {.importc: "DeactivateActCtx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int DeactivateActCtx(
    uint dwFlags,   // DWORD
    size_t ulCookie   // UINT_PTR
);
ccall((:DeactivateActCtx, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Csize_t),
      dwFlags, ulCookie)
# dwFlags : DWORD -> UInt32
# ulCookie : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeactivateActCtx(
    uint32_t dwFlags,
    uintptr_t ulCookie);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.DeactivateActCtx(dwFlags, ulCookie)
-- dwFlags : DWORD
-- ulCookie : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const DeactivateActCtx = lib.func('__stdcall', 'DeactivateActCtx', 'int32_t', ['uint32_t', 'uintptr_t']);
// DeactivateActCtx(dwFlags, ulCookie)
// dwFlags : DWORD -> 'uint32_t'
// ulCookie : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  DeactivateActCtx: { parameters: ["u32", "usize"], result: "i32" },
});
// lib.symbols.DeactivateActCtx(dwFlags, ulCookie)
// dwFlags : DWORD -> "u32"
// ulCookie : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeactivateActCtx(
    uint32_t dwFlags,
    size_t ulCookie);
C, "KERNEL32.dll");
// $ffi->DeactivateActCtx(dwFlags, ulCookie);
// dwFlags : DWORD
// ulCookie : UINT_PTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean DeactivateActCtx(
        int dwFlags,   // DWORD
        long ulCookie   // UINT_PTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun DeactivateActCtx = DeactivateActCtx(
    dwFlags : UInt32,   # DWORD
    ulCookie : LibC::SizeT   # UINT_PTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeactivateActCtxNative = Int32 Function(Uint32, UintPtr);
typedef DeactivateActCtxDart = int Function(int, int);
final DeactivateActCtx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<DeactivateActCtxNative, DeactivateActCtxDart>('DeactivateActCtx');
// dwFlags : DWORD -> Uint32
// ulCookie : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeactivateActCtx(
  dwFlags: DWORD;   // DWORD
  ulCookie: NativeUInt   // UINT_PTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'DeactivateActCtx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeactivateActCtx"
  c_DeactivateActCtx :: Word32 -> CUIntPtr -> IO CInt
-- dwFlags : DWORD -> Word32
-- ulCookie : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let deactivateactctx =
  foreign "DeactivateActCtx"
    (uint32_t @-> size_t @-> returning int32_t)
(* dwFlags : DWORD -> uint32_t *)
(* ulCookie : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("DeactivateActCtx" deactivate-act-ctx :convention :stdcall) :int32
  (dw-flags :uint32)   ; DWORD
  (ul-cookie :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeactivateActCtx = Win32::API::More->new('KERNEL32',
    'BOOL DeactivateActCtx(DWORD dwFlags, WPARAM ulCookie)');
# my $ret = $DeactivateActCtx->Call($dwFlags, $ulCookie);
# dwFlags : DWORD -> DWORD
# ulCookie : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目