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

RmGetList

関数
登録リソースを使用中のアプリ一覧を取得する。
DLLrstrtmgr.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR RmGetList(
    DWORD dwSessionHandle,
    DWORD* pnProcInfoNeeded,
    DWORD* pnProcInfo,
    RM_PROCESS_INFO* rgAffectedApps,   // optional
    DWORD* lpdwRebootReasons
);

パラメーター

名前方向説明
dwSessionHandleDWORDin影響を受けるアプリを照会する対象のセッションハンドル。
pnProcInfoNeededDWORD*out全情報の格納に必要な配列要素数を受け取る変数へのポインター。
pnProcInfoDWORD*inout入力時は配列の容量、出力時は格納された要素数を示す変数へのポインター。
rgAffectedAppsRM_PROCESS_INFO*inoutoptional影響を受けるアプリ情報を受け取る RM_PROCESS_INFO 構造体の配列。
lpdwRebootReasonsDWORD*out再起動が必要な理由を示すビットフラグを受け取る変数へのポインター。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR RmGetList(
    DWORD dwSessionHandle,
    DWORD* pnProcInfoNeeded,
    DWORD* pnProcInfo,
    RM_PROCESS_INFO* rgAffectedApps,   // optional
    DWORD* lpdwRebootReasons
);
[DllImport("rstrtmgr.dll", ExactSpelling = true)]
static extern uint RmGetList(
    uint dwSessionHandle,   // DWORD
    out uint pnProcInfoNeeded,   // DWORD* out
    ref uint pnProcInfo,   // DWORD* in/out
    IntPtr rgAffectedApps,   // RM_PROCESS_INFO* optional, in/out
    out uint lpdwRebootReasons   // DWORD* out
);
<DllImport("rstrtmgr.dll", ExactSpelling:=True)>
Public Shared Function RmGetList(
    dwSessionHandle As UInteger,   ' DWORD
    <Out> ByRef pnProcInfoNeeded As UInteger,   ' DWORD* out
    ByRef pnProcInfo As UInteger,   ' DWORD* in/out
    rgAffectedApps As IntPtr,   ' RM_PROCESS_INFO* optional, in/out
    <Out> ByRef lpdwRebootReasons As UInteger   ' DWORD* out
) As UInteger
End Function
' dwSessionHandle : DWORD
' pnProcInfoNeeded : DWORD* out
' pnProcInfo : DWORD* in/out
' rgAffectedApps : RM_PROCESS_INFO* optional, in/out
' lpdwRebootReasons : DWORD* out
Declare PtrSafe Function RmGetList Lib "rstrtmgr" ( _
    ByVal dwSessionHandle As Long, _
    ByRef pnProcInfoNeeded As Long, _
    ByRef pnProcInfo As Long, _
    ByVal rgAffectedApps As LongPtr, _
    ByRef lpdwRebootReasons As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RmGetList = ctypes.windll.rstrtmgr.RmGetList
RmGetList.restype = wintypes.DWORD
RmGetList.argtypes = [
    wintypes.DWORD,  # dwSessionHandle : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pnProcInfoNeeded : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pnProcInfo : DWORD* in/out
    ctypes.c_void_p,  # rgAffectedApps : RM_PROCESS_INFO* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwRebootReasons : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rstrtmgr.dll')
RmGetList = Fiddle::Function.new(
  lib['RmGetList'],
  [
    -Fiddle::TYPE_INT,  # dwSessionHandle : DWORD
    Fiddle::TYPE_VOIDP,  # pnProcInfoNeeded : DWORD* out
    Fiddle::TYPE_VOIDP,  # pnProcInfo : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # rgAffectedApps : RM_PROCESS_INFO* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpdwRebootReasons : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "rstrtmgr")]
extern "system" {
    fn RmGetList(
        dwSessionHandle: u32,  // DWORD
        pnProcInfoNeeded: *mut u32,  // DWORD* out
        pnProcInfo: *mut u32,  // DWORD* in/out
        rgAffectedApps: *mut RM_PROCESS_INFO,  // RM_PROCESS_INFO* optional, in/out
        lpdwRebootReasons: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rstrtmgr.dll")]
public static extern uint RmGetList(uint dwSessionHandle, out uint pnProcInfoNeeded, ref uint pnProcInfo, IntPtr rgAffectedApps, out uint lpdwRebootReasons);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rstrtmgr_RmGetList' -Namespace Win32 -PassThru
# $api::RmGetList(dwSessionHandle, pnProcInfoNeeded, pnProcInfo, rgAffectedApps, lpdwRebootReasons)
#uselib "rstrtmgr.dll"
#func global RmGetList "RmGetList" sptr, sptr, sptr, sptr, sptr
; RmGetList dwSessionHandle, varptr(pnProcInfoNeeded), varptr(pnProcInfo), varptr(rgAffectedApps), varptr(lpdwRebootReasons)   ; 戻り値は stat
; dwSessionHandle : DWORD -> "sptr"
; pnProcInfoNeeded : DWORD* out -> "sptr"
; pnProcInfo : DWORD* in/out -> "sptr"
; rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> "sptr"
; lpdwRebootReasons : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "rstrtmgr.dll"
#cfunc global RmGetList "RmGetList" int, var, var, var, var
; res = RmGetList(dwSessionHandle, pnProcInfoNeeded, pnProcInfo, rgAffectedApps, lpdwRebootReasons)
; dwSessionHandle : DWORD -> "int"
; pnProcInfoNeeded : DWORD* out -> "var"
; pnProcInfo : DWORD* in/out -> "var"
; rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> "var"
; lpdwRebootReasons : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR RmGetList(DWORD dwSessionHandle, DWORD* pnProcInfoNeeded, DWORD* pnProcInfo, RM_PROCESS_INFO* rgAffectedApps, DWORD* lpdwRebootReasons)
#uselib "rstrtmgr.dll"
#cfunc global RmGetList "RmGetList" int, var, var, var, var
; res = RmGetList(dwSessionHandle, pnProcInfoNeeded, pnProcInfo, rgAffectedApps, lpdwRebootReasons)
; dwSessionHandle : DWORD -> "int"
; pnProcInfoNeeded : DWORD* out -> "var"
; pnProcInfo : DWORD* in/out -> "var"
; rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> "var"
; lpdwRebootReasons : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rstrtmgr = windows.NewLazySystemDLL("rstrtmgr.dll")
	procRmGetList = rstrtmgr.NewProc("RmGetList")
)

// dwSessionHandle (DWORD), pnProcInfoNeeded (DWORD* out), pnProcInfo (DWORD* in/out), rgAffectedApps (RM_PROCESS_INFO* optional, in/out), lpdwRebootReasons (DWORD* out)
r1, _, err := procRmGetList.Call(
	uintptr(dwSessionHandle),
	uintptr(pnProcInfoNeeded),
	uintptr(pnProcInfo),
	uintptr(rgAffectedApps),
	uintptr(lpdwRebootReasons),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RmGetList(
  dwSessionHandle: DWORD;   // DWORD
  pnProcInfoNeeded: Pointer;   // DWORD* out
  pnProcInfo: Pointer;   // DWORD* in/out
  rgAffectedApps: Pointer;   // RM_PROCESS_INFO* optional, in/out
  lpdwRebootReasons: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmGetList';
result := DllCall("rstrtmgr\RmGetList"
    , "UInt", dwSessionHandle   ; DWORD
    , "Ptr", pnProcInfoNeeded   ; DWORD* out
    , "Ptr", pnProcInfo   ; DWORD* in/out
    , "Ptr", rgAffectedApps   ; RM_PROCESS_INFO* optional, in/out
    , "Ptr", lpdwRebootReasons   ; DWORD* out
    , "UInt")   ; return: WIN32_ERROR
●RmGetList(dwSessionHandle, pnProcInfoNeeded, pnProcInfo, rgAffectedApps, lpdwRebootReasons) = DLL("rstrtmgr.dll", "dword RmGetList(dword, void*, void*, void*, void*)")
# 呼び出し: RmGetList(dwSessionHandle, pnProcInfoNeeded, pnProcInfo, rgAffectedApps, lpdwRebootReasons)
# dwSessionHandle : DWORD -> "dword"
# pnProcInfoNeeded : DWORD* out -> "void*"
# pnProcInfo : DWORD* in/out -> "void*"
# rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> "void*"
# lpdwRebootReasons : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RmGetListNative = Uint32 Function(Uint32, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
typedef RmGetListDart = int Function(int, Pointer<Uint32>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>);
final RmGetList = DynamicLibrary.open('rstrtmgr.dll')
    .lookupFunction<RmGetListNative, RmGetListDart>('RmGetList');
// dwSessionHandle : DWORD -> Uint32
// pnProcInfoNeeded : DWORD* out -> Pointer<Uint32>
// pnProcInfo : DWORD* in/out -> Pointer<Uint32>
// rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> Pointer<Void>
// lpdwRebootReasons : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RmGetList(
  dwSessionHandle: DWORD;   // DWORD
  pnProcInfoNeeded: Pointer;   // DWORD* out
  pnProcInfo: Pointer;   // DWORD* in/out
  rgAffectedApps: Pointer;   // RM_PROCESS_INFO* optional, in/out
  lpdwRebootReasons: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmGetList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RmGetList"
  c_RmGetList :: Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- dwSessionHandle : DWORD -> Word32
-- pnProcInfoNeeded : DWORD* out -> Ptr Word32
-- pnProcInfo : DWORD* in/out -> Ptr Word32
-- rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> Ptr ()
-- lpdwRebootReasons : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rmgetlist =
  foreign "RmGetList"
    (uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* dwSessionHandle : DWORD -> uint32_t *)
(* pnProcInfoNeeded : DWORD* out -> (ptr uint32_t) *)
(* pnProcInfo : DWORD* in/out -> (ptr uint32_t) *)
(* rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> (ptr void) *)
(* lpdwRebootReasons : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rstrtmgr (t "rstrtmgr.dll"))
(cffi:use-foreign-library rstrtmgr)

(cffi:defcfun ("RmGetList" rm-get-list :convention :stdcall) :uint32
  (dw-session-handle :uint32)   ; DWORD
  (pn-proc-info-needed :pointer)   ; DWORD* out
  (pn-proc-info :pointer)   ; DWORD* in/out
  (rg-affected-apps :pointer)   ; RM_PROCESS_INFO* optional, in/out
  (lpdw-reboot-reasons :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RmGetList = Win32::API::More->new('rstrtmgr',
    'DWORD RmGetList(DWORD dwSessionHandle, LPVOID pnProcInfoNeeded, LPVOID pnProcInfo, LPVOID rgAffectedApps, LPVOID lpdwRebootReasons)');
# my $ret = $RmGetList->Call($dwSessionHandle, $pnProcInfoNeeded, $pnProcInfo, $rgAffectedApps, $lpdwRebootReasons);
# dwSessionHandle : DWORD -> DWORD
# pnProcInfoNeeded : DWORD* out -> LPVOID
# pnProcInfo : DWORD* in/out -> LPVOID
# rgAffectedApps : RM_PROCESS_INFO* optional, in/out -> LPVOID
# lpdwRebootReasons : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型