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

MsiCloseAllHandles

関数
開いているすべてのMSIハンドルを閉じる。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiCloseAllHandles(void);

パラメーターなし。戻り値: DWORD

公式ドキュメント

MsiCloseAllHandles 関数は、現在のスレッドによって割り当てられたすべての開かれているインストールハンドルを閉じます。これは診断用の関数であり、クリーンアップ目的で使用すべきではありません。

戻り値

すべてのハンドルが閉じられた場合、この関数は 0 を返します。それ以外の場合、呼び出し前に開かれていたハンドルの数を返します。

解説(Remarks)

MsiCloseAllHandles は呼び出し元のスレッドによって割り当てられたハンドルのみを閉じ、カスタムアクションに渡されるインストールハンドルなど、他のスレッドによって割り当てられたハンドルには影響しません。

MsiOpenPackage 関数はパッケージへのハンドルを開き、 MsiOpenProduct 関数は製品へのハンドルを開きます。これらの関数は、製品データベースにアクセスする関数とともに使用します。

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

各言語での呼び出し定義

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

DWORD MsiCloseAllHandles(void);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiCloseAllHandles();
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiCloseAllHandles() As UInteger
End Function
Declare PtrSafe Function MsiCloseAllHandles Lib "msi" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiCloseAllHandles = ctypes.windll.msi.MsiCloseAllHandles
MsiCloseAllHandles.restype = wintypes.DWORD
MsiCloseAllHandles.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiCloseAllHandles = Fiddle::Function.new(
  lib['MsiCloseAllHandles'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiCloseAllHandles() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiCloseAllHandles();
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiCloseAllHandles' -Namespace Win32 -PassThru
# $api::MsiCloseAllHandles()
#uselib "msi.dll"
#func global MsiCloseAllHandles "MsiCloseAllHandles"
; MsiCloseAllHandles   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiCloseAllHandles "MsiCloseAllHandles"
; res = MsiCloseAllHandles()
; DWORD MsiCloseAllHandles()
#uselib "msi.dll"
#cfunc global MsiCloseAllHandles "MsiCloseAllHandles"
; res = MsiCloseAllHandles()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiCloseAllHandles = msi.NewProc("MsiCloseAllHandles")
)

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

extern "msi" fn MsiCloseAllHandles() callconv(std.os.windows.WINAPI) u32;
proc MsiCloseAllHandles(): uint32 {.importc: "MsiCloseAllHandles", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiCloseAllHandles();
ccall((:MsiCloseAllHandles, "msi.dll"), stdcall, UInt32,
      (),
      )
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiCloseAllHandles(void);
]]
local msi = ffi.load("msi")
-- msi.MsiCloseAllHandles()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiCloseAllHandles = lib.func('__stdcall', 'MsiCloseAllHandles', 'uint32_t', []);
// MsiCloseAllHandles()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiCloseAllHandles: { parameters: [], result: "u32" },
});
// lib.symbols.MsiCloseAllHandles()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiCloseAllHandles(void);
C, "msi.dll");
// $ffi->MsiCloseAllHandles();
// 構造体/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 Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class);
    int MsiCloseAllHandles();
}
@[Link("msi")]
lib Libmsi
  fun MsiCloseAllHandles = MsiCloseAllHandles() : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiCloseAllHandlesNative = Uint32 Function();
typedef MsiCloseAllHandlesDart = int Function();
final MsiCloseAllHandles = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiCloseAllHandlesNative, MsiCloseAllHandlesDart>('MsiCloseAllHandles');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiCloseAllHandles: DWORD; stdcall;
  external 'msi.dll' name 'MsiCloseAllHandles';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiCloseAllHandles"
  c_MsiCloseAllHandles :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msicloseallhandles =
  foreign "MsiCloseAllHandles"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiCloseAllHandles" msi-close-all-handles :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiCloseAllHandles = Win32::API::More->new('msi',
    'DWORD MsiCloseAllHandles()');
# my $ret = $MsiCloseAllHandles->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。