Win32 API 日本語リファレンス
ホームStorage.InstallableFileSystems › FilterConnectCommunicationPort

FilterConnectCommunicationPort

関数
ミニフィルターの通信ポートに接続しハンドルを取得する。
DLLFLTLIB.dll呼出規約winapi

シグネチャ

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

HRESULT FilterConnectCommunicationPort(
    LPCWSTR lpPortName,
    DWORD dwOptions,
    const void* lpContext,   // optional
    WORD wSizeOfContext,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HANDLE* hPort
);

パラメーター

名前方向説明
lpPortNameLPCWSTRin接続先のフィルター通信ポート名を指す。
dwOptionsDWORDin接続オプションを指定するフラグ。通常は0を指定する。
lpContextvoid*inoptionalポートへ渡す接続コンテキストデータを指す。NULL可。
wSizeOfContextWORDinlpContextのサイズをバイト単位で指定するWORD値。
lpSecurityAttributesSECURITY_ATTRIBUTES*inoptionalハンドル継承を制御するSECURITY_ATTRIBUTES構造体へのポインタ。NULL可。
hPortHANDLE*out確立された接続ポートのハンドルを受け取るHANDLEへのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT FilterConnectCommunicationPort(
    LPCWSTR lpPortName,
    DWORD dwOptions,
    const void* lpContext,   // optional
    WORD wSizeOfContext,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HANDLE* hPort
);
[DllImport("FLTLIB.dll", ExactSpelling = true)]
static extern int FilterConnectCommunicationPort(
    [MarshalAs(UnmanagedType.LPWStr)] string lpPortName,   // LPCWSTR
    uint dwOptions,   // DWORD
    IntPtr lpContext,   // void* optional
    ushort wSizeOfContext,   // WORD
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    IntPtr hPort   // HANDLE* out
);
<DllImport("FLTLIB.dll", ExactSpelling:=True)>
Public Shared Function FilterConnectCommunicationPort(
    <MarshalAs(UnmanagedType.LPWStr)> lpPortName As String,   ' LPCWSTR
    dwOptions As UInteger,   ' DWORD
    lpContext As IntPtr,   ' void* optional
    wSizeOfContext As UShort,   ' WORD
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    hPort As IntPtr   ' HANDLE* out
) As Integer
End Function
' lpPortName : LPCWSTR
' dwOptions : DWORD
' lpContext : void* optional
' wSizeOfContext : WORD
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' hPort : HANDLE* out
Declare PtrSafe Function FilterConnectCommunicationPort Lib "fltlib" ( _
    ByVal lpPortName As LongPtr, _
    ByVal dwOptions As Long, _
    ByVal lpContext As LongPtr, _
    ByVal wSizeOfContext As Integer, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal hPort As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FilterConnectCommunicationPort = ctypes.windll.fltlib.FilterConnectCommunicationPort
FilterConnectCommunicationPort.restype = ctypes.c_int
FilterConnectCommunicationPort.argtypes = [
    wintypes.LPCWSTR,  # lpPortName : LPCWSTR
    wintypes.DWORD,  # dwOptions : DWORD
    ctypes.POINTER(None),  # lpContext : void* optional
    ctypes.c_ushort,  # wSizeOfContext : WORD
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    ctypes.c_void_p,  # hPort : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('FLTLIB.dll')
FilterConnectCommunicationPort = Fiddle::Function.new(
  lib['FilterConnectCommunicationPort'],
  [
    Fiddle::TYPE_VOIDP,  # lpPortName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
    Fiddle::TYPE_VOIDP,  # lpContext : void* optional
    -Fiddle::TYPE_SHORT,  # wSizeOfContext : WORD
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_VOIDP,  # hPort : HANDLE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "fltlib")]
extern "system" {
    fn FilterConnectCommunicationPort(
        lpPortName: *const u16,  // LPCWSTR
        dwOptions: u32,  // DWORD
        lpContext: *const (),  // void* optional
        wSizeOfContext: u16,  // WORD
        lpSecurityAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        hPort: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("FLTLIB.dll")]
public static extern int FilterConnectCommunicationPort([MarshalAs(UnmanagedType.LPWStr)] string lpPortName, uint dwOptions, IntPtr lpContext, ushort wSizeOfContext, IntPtr lpSecurityAttributes, IntPtr hPort);
"@
$api = Add-Type -MemberDefinition $sig -Name 'FLTLIB_FilterConnectCommunicationPort' -Namespace Win32 -PassThru
# $api::FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, lpSecurityAttributes, hPort)
#uselib "FLTLIB.dll"
#func global FilterConnectCommunicationPort "FilterConnectCommunicationPort" sptr, sptr, sptr, sptr, sptr, sptr
; FilterConnectCommunicationPort lpPortName, dwOptions, lpContext, wSizeOfContext, varptr(lpSecurityAttributes), hPort   ; 戻り値は stat
; lpPortName : LPCWSTR -> "sptr"
; dwOptions : DWORD -> "sptr"
; lpContext : void* optional -> "sptr"
; wSizeOfContext : WORD -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; hPort : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "FLTLIB.dll"
#cfunc global FilterConnectCommunicationPort "FilterConnectCommunicationPort" wstr, int, sptr, int, var, sptr
; res = FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, lpSecurityAttributes, hPort)
; lpPortName : LPCWSTR -> "wstr"
; dwOptions : DWORD -> "int"
; lpContext : void* optional -> "sptr"
; wSizeOfContext : WORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; hPort : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT FilterConnectCommunicationPort(LPCWSTR lpPortName, DWORD dwOptions, void* lpContext, WORD wSizeOfContext, SECURITY_ATTRIBUTES* lpSecurityAttributes, HANDLE* hPort)
#uselib "FLTLIB.dll"
#cfunc global FilterConnectCommunicationPort "FilterConnectCommunicationPort" wstr, int, intptr, int, var, intptr
; res = FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, lpSecurityAttributes, hPort)
; lpPortName : LPCWSTR -> "wstr"
; dwOptions : DWORD -> "int"
; lpContext : void* optional -> "intptr"
; wSizeOfContext : WORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; hPort : HANDLE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fltlib = windows.NewLazySystemDLL("FLTLIB.dll")
	procFilterConnectCommunicationPort = fltlib.NewProc("FilterConnectCommunicationPort")
)

// lpPortName (LPCWSTR), dwOptions (DWORD), lpContext (void* optional), wSizeOfContext (WORD), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional), hPort (HANDLE* out)
r1, _, err := procFilterConnectCommunicationPort.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpPortName))),
	uintptr(dwOptions),
	uintptr(lpContext),
	uintptr(wSizeOfContext),
	uintptr(lpSecurityAttributes),
	uintptr(hPort),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function FilterConnectCommunicationPort(
  lpPortName: PWideChar;   // LPCWSTR
  dwOptions: DWORD;   // DWORD
  lpContext: Pointer;   // void* optional
  wSizeOfContext: Word;   // WORD
  lpSecurityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  hPort: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'FLTLIB.dll' name 'FilterConnectCommunicationPort';
result := DllCall("FLTLIB\FilterConnectCommunicationPort"
    , "WStr", lpPortName   ; LPCWSTR
    , "UInt", dwOptions   ; DWORD
    , "Ptr", lpContext   ; void* optional
    , "UShort", wSizeOfContext   ; WORD
    , "Ptr", lpSecurityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Ptr", hPort   ; HANDLE* out
    , "Int")   ; return: HRESULT
●FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, lpSecurityAttributes, hPort) = DLL("FLTLIB.dll", "int FilterConnectCommunicationPort(char*, dword, void*, int, void*, void*)")
# 呼び出し: FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, lpSecurityAttributes, hPort)
# lpPortName : LPCWSTR -> "char*"
# dwOptions : DWORD -> "dword"
# lpContext : void* optional -> "void*"
# wSizeOfContext : WORD -> "int"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# hPort : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FilterConnectCommunicationPortNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Uint16, Pointer<Void>, Pointer<Void>);
typedef FilterConnectCommunicationPortDart = int Function(Pointer<Utf16>, int, Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final FilterConnectCommunicationPort = DynamicLibrary.open('FLTLIB.dll')
    .lookupFunction<FilterConnectCommunicationPortNative, FilterConnectCommunicationPortDart>('FilterConnectCommunicationPort');
// lpPortName : LPCWSTR -> Pointer<Utf16>
// dwOptions : DWORD -> Uint32
// lpContext : void* optional -> Pointer<Void>
// wSizeOfContext : WORD -> Uint16
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// hPort : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FilterConnectCommunicationPort(
  lpPortName: PWideChar;   // LPCWSTR
  dwOptions: DWORD;   // DWORD
  lpContext: Pointer;   // void* optional
  wSizeOfContext: Word;   // WORD
  lpSecurityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  hPort: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'FLTLIB.dll' name 'FilterConnectCommunicationPort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FilterConnectCommunicationPort"
  c_FilterConnectCommunicationPort :: CWString -> Word32 -> Ptr () -> Word16 -> Ptr () -> Ptr () -> IO Int32
-- lpPortName : LPCWSTR -> CWString
-- dwOptions : DWORD -> Word32
-- lpContext : void* optional -> Ptr ()
-- wSizeOfContext : WORD -> Word16
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- hPort : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let filterconnectcommunicationport =
  foreign "FilterConnectCommunicationPort"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> uint16_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpPortName : LPCWSTR -> (ptr uint16_t) *)
(* dwOptions : DWORD -> uint32_t *)
(* lpContext : void* optional -> (ptr void) *)
(* wSizeOfContext : WORD -> uint16_t *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* hPort : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fltlib (t "FLTLIB.dll"))
(cffi:use-foreign-library fltlib)

(cffi:defcfun ("FilterConnectCommunicationPort" filter-connect-communication-port :convention :stdcall) :int32
  (lp-port-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-options :uint32)   ; DWORD
  (lp-context :pointer)   ; void* optional
  (w-size-of-context :uint16)   ; WORD
  (lp-security-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (h-port :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FilterConnectCommunicationPort = Win32::API::More->new('FLTLIB',
    'int FilterConnectCommunicationPort(LPCWSTR lpPortName, DWORD dwOptions, LPVOID lpContext, WORD wSizeOfContext, LPVOID lpSecurityAttributes, HANDLE hPort)');
# my $ret = $FilterConnectCommunicationPort->Call($lpPortName, $dwOptions, $lpContext, $wSizeOfContext, $lpSecurityAttributes, $hPort);
# lpPortName : LPCWSTR -> LPCWSTR
# dwOptions : DWORD -> DWORD
# lpContext : void* optional -> LPVOID
# wSizeOfContext : WORD -> WORD
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# hPort : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型