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

RmGetFilterList

関数
現在のフィルター一覧を取得する。
DLLRstrtMgr.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR RmGetFilterList(
    DWORD dwSessionHandle,
    BYTE* pbFilterBuf,   // optional
    DWORD cbFilterBuf,
    DWORD* cbFilterBufNeeded
);

パラメーター

名前方向
dwSessionHandleDWORDin
pbFilterBufBYTE*outoptional
cbFilterBufDWORDin
cbFilterBufNeededDWORD*out

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

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

RmGetFilterList = ctypes.windll.rstrtmgr.RmGetFilterList
RmGetFilterList.restype = wintypes.DWORD
RmGetFilterList.argtypes = [
    wintypes.DWORD,  # dwSessionHandle : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbFilterBuf : BYTE* optional, out
    wintypes.DWORD,  # cbFilterBuf : DWORD
    ctypes.POINTER(wintypes.DWORD),  # cbFilterBufNeeded : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rstrtmgr = windows.NewLazySystemDLL("RstrtMgr.dll")
	procRmGetFilterList = rstrtmgr.NewProc("RmGetFilterList")
)

// dwSessionHandle (DWORD), pbFilterBuf (BYTE* optional, out), cbFilterBuf (DWORD), cbFilterBufNeeded (DWORD* out)
r1, _, err := procRmGetFilterList.Call(
	uintptr(dwSessionHandle),
	uintptr(pbFilterBuf),
	uintptr(cbFilterBuf),
	uintptr(cbFilterBufNeeded),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function RmGetFilterList(
  dwSessionHandle: DWORD;   // DWORD
  pbFilterBuf: Pointer;   // BYTE* optional, out
  cbFilterBuf: DWORD;   // DWORD
  cbFilterBufNeeded: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'RstrtMgr.dll' name 'RmGetFilterList';
result := DllCall("RstrtMgr\RmGetFilterList"
    , "UInt", dwSessionHandle   ; DWORD
    , "Ptr", pbFilterBuf   ; BYTE* optional, out
    , "UInt", cbFilterBuf   ; DWORD
    , "Ptr", cbFilterBufNeeded   ; DWORD* out
    , "UInt")   ; return: WIN32_ERROR
●RmGetFilterList(dwSessionHandle, pbFilterBuf, cbFilterBuf, cbFilterBufNeeded) = DLL("RstrtMgr.dll", "dword RmGetFilterList(dword, void*, dword, void*)")
# 呼び出し: RmGetFilterList(dwSessionHandle, pbFilterBuf, cbFilterBuf, cbFilterBufNeeded)
# dwSessionHandle : DWORD -> "dword"
# pbFilterBuf : BYTE* optional, out -> "void*"
# cbFilterBuf : DWORD -> "dword"
# cbFilterBufNeeded : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。