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

RmAddFilter

関数
再起動対象から除外するフィルターを追加する。
DLLrstrtmgr.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR RmAddFilter(
    DWORD dwSessionHandle,
    LPCWSTR strModuleName,   // optional
    RM_UNIQUE_PROCESS* pProcess,   // optional
    LPCWSTR strServiceShortName,   // optional
    RM_FILTER_ACTION FilterAction
);

パラメーター

名前型方向説明
dwSessionHandleDWORDinフィルターを追加する対象のセッションハンドル。
strModuleNameLPCWSTRinoptionalフィルター対象のモジュール(ファイル)のフルパス文字列。NULL 可。
pProcessRM_UNIQUE_PROCESS*inoptionalフィルター対象のアプリを識別する RM_UNIQUE_PROCESS 構造体へのポインター。NULL 可。
strServiceShortNameLPCWSTRinoptionalフィルター対象サービスの短い名前文字列。NULL 可。
FilterActionRM_FILTER_ACTIONin適用するフィルター動作を示す RM_FILTER_ACTION 列挙値。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR RmAddFilter(
    DWORD dwSessionHandle,
    LPCWSTR strModuleName,   // optional
    RM_UNIQUE_PROCESS* pProcess,   // optional
    LPCWSTR strServiceShortName,   // optional
    RM_FILTER_ACTION FilterAction
);
[DllImport("rstrtmgr.dll", ExactSpelling = true)]
static extern uint RmAddFilter(
    uint dwSessionHandle,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string strModuleName,   // LPCWSTR optional
    IntPtr pProcess,   // RM_UNIQUE_PROCESS* optional
    [MarshalAs(UnmanagedType.LPWStr)] string strServiceShortName,   // LPCWSTR optional
    int FilterAction   // RM_FILTER_ACTION
);
<DllImport("rstrtmgr.dll", ExactSpelling:=True)>
Public Shared Function RmAddFilter(
    dwSessionHandle As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> strModuleName As String,   ' LPCWSTR optional
    pProcess As IntPtr,   ' RM_UNIQUE_PROCESS* optional
    <MarshalAs(UnmanagedType.LPWStr)> strServiceShortName As String,   ' LPCWSTR optional
    FilterAction As Integer   ' RM_FILTER_ACTION
) As UInteger
End Function
' dwSessionHandle : DWORD
' strModuleName : LPCWSTR optional
' pProcess : RM_UNIQUE_PROCESS* optional
' strServiceShortName : LPCWSTR optional
' FilterAction : RM_FILTER_ACTION
Declare PtrSafe Function RmAddFilter Lib "rstrtmgr" ( _
    ByVal dwSessionHandle As Long, _
    ByVal strModuleName As LongPtr, _
    ByVal pProcess As LongPtr, _
    ByVal strServiceShortName As LongPtr, _
    ByVal FilterAction As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RmAddFilter = ctypes.windll.rstrtmgr.RmAddFilter
RmAddFilter.restype = wintypes.DWORD
RmAddFilter.argtypes = [
    wintypes.DWORD,  # dwSessionHandle : DWORD
    wintypes.LPCWSTR,  # strModuleName : LPCWSTR optional
    ctypes.c_void_p,  # pProcess : RM_UNIQUE_PROCESS* optional
    wintypes.LPCWSTR,  # strServiceShortName : LPCWSTR optional
    ctypes.c_int,  # FilterAction : RM_FILTER_ACTION
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rstrtmgr = windows.NewLazySystemDLL("rstrtmgr.dll")
	procRmAddFilter = rstrtmgr.NewProc("RmAddFilter")
)

// dwSessionHandle (DWORD), strModuleName (LPCWSTR optional), pProcess (RM_UNIQUE_PROCESS* optional), strServiceShortName (LPCWSTR optional), FilterAction (RM_FILTER_ACTION)
r1, _, err := procRmAddFilter.Call(
	uintptr(dwSessionHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strModuleName))),
	uintptr(pProcess),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strServiceShortName))),
	uintptr(FilterAction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RmAddFilter(
  dwSessionHandle: DWORD;   // DWORD
  strModuleName: PWideChar;   // LPCWSTR optional
  pProcess: Pointer;   // RM_UNIQUE_PROCESS* optional
  strServiceShortName: PWideChar;   // LPCWSTR optional
  FilterAction: Integer   // RM_FILTER_ACTION
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmAddFilter';
result := DllCall("rstrtmgr\RmAddFilter"
    , "UInt", dwSessionHandle   ; DWORD
    , "WStr", strModuleName   ; LPCWSTR optional
    , "Ptr", pProcess   ; RM_UNIQUE_PROCESS* optional
    , "WStr", strServiceShortName   ; LPCWSTR optional
    , "Int", FilterAction   ; RM_FILTER_ACTION
    , "UInt")   ; return: WIN32_ERROR
●RmAddFilter(dwSessionHandle, strModuleName, pProcess, strServiceShortName, FilterAction) = DLL("rstrtmgr.dll", "dword RmAddFilter(dword, char*, void*, char*, int)")
# 呼び出し: RmAddFilter(dwSessionHandle, strModuleName, pProcess, strServiceShortName, FilterAction)
# dwSessionHandle : DWORD -> "dword"
# strModuleName : LPCWSTR optional -> "char*"
# pProcess : RM_UNIQUE_PROCESS* optional -> "void*"
# strServiceShortName : LPCWSTR optional -> "char*"
# FilterAction : RM_FILTER_ACTION -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RmAddFilterNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Int32);
typedef RmAddFilterDart = int Function(int, Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, int);
final RmAddFilter = DynamicLibrary.open('rstrtmgr.dll')
    .lookupFunction<RmAddFilterNative, RmAddFilterDart>('RmAddFilter');
// dwSessionHandle : DWORD -> Uint32
// strModuleName : LPCWSTR optional -> Pointer<Utf16>
// pProcess : RM_UNIQUE_PROCESS* optional -> Pointer<Void>
// strServiceShortName : LPCWSTR optional -> Pointer<Utf16>
// FilterAction : RM_FILTER_ACTION -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RmAddFilter(
  dwSessionHandle: DWORD;   // DWORD
  strModuleName: PWideChar;   // LPCWSTR optional
  pProcess: Pointer;   // RM_UNIQUE_PROCESS* optional
  strServiceShortName: PWideChar;   // LPCWSTR optional
  FilterAction: Integer   // RM_FILTER_ACTION
): DWORD; stdcall;
  external 'rstrtmgr.dll' name 'RmAddFilter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RmAddFilter"
  c_RmAddFilter :: Word32 -> CWString -> Ptr () -> CWString -> Int32 -> IO Word32
-- dwSessionHandle : DWORD -> Word32
-- strModuleName : LPCWSTR optional -> CWString
-- pProcess : RM_UNIQUE_PROCESS* optional -> Ptr ()
-- strServiceShortName : LPCWSTR optional -> CWString
-- FilterAction : RM_FILTER_ACTION -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rmaddfilter =
  foreign "RmAddFilter"
    (uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> int32_t @-> returning uint32_t)
(* dwSessionHandle : DWORD -> uint32_t *)
(* strModuleName : LPCWSTR optional -> (ptr uint16_t) *)
(* pProcess : RM_UNIQUE_PROCESS* optional -> (ptr void) *)
(* strServiceShortName : LPCWSTR optional -> (ptr uint16_t) *)
(* FilterAction : RM_FILTER_ACTION -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rstrtmgr (t "rstrtmgr.dll"))
(cffi:use-foreign-library rstrtmgr)

(cffi:defcfun ("RmAddFilter" rm-add-filter :convention :stdcall) :uint32
  (dw-session-handle :uint32)   ; DWORD
  (str-module-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (p-process :pointer)   ; RM_UNIQUE_PROCESS* optional
  (str-service-short-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (filter-action :int32))   ; RM_FILTER_ACTION
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RmAddFilter = Win32::API::More->new('rstrtmgr',
    'DWORD RmAddFilter(DWORD dwSessionHandle, LPCWSTR strModuleName, LPVOID pProcess, LPCWSTR strServiceShortName, int FilterAction)');
# my $ret = $RmAddFilter->Call($dwSessionHandle, $strModuleName, $pProcess, $strServiceShortName, $FilterAction);
# dwSessionHandle : DWORD -> DWORD
# strModuleName : LPCWSTR optional -> LPCWSTR
# pProcess : RM_UNIQUE_PROCESS* optional -> LPVOID
# strServiceShortName : LPCWSTR optional -> LPCWSTR
# FilterAction : RM_FILTER_ACTION -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型