ホーム › 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
);

パラメーター

名前

型

方向

説明

lpPortName

LPCWSTR

通信サーバーポートの完全修飾名を格納する、NULL で終わるワイド文字列へのポインター (例: L"\MyFilterPort")。

dwOptions

DWORD

通信ポートの接続オプション。Windows 8.1 より前では、この値には 0 を指定します。

値	意味
FLT_PORT_FLAG_SYNC_HANDLE	hPort に返されるハンドルは同期 I/O 用です。このフラグは Windows 8.1 以降で使用できます。

lpContext

void*

inoptional

カーネルモードのミニフィルターの接続通知ルーチンに渡される、呼び出し元が指定したコンテキスト情報へのポインター。(FltCreateCommunicationPort のリファレンスページにある ConnectNotifyCallback パラメーターを参照してください。) このパラメーターは省略可能であり、NULL を指定できます。

wSizeOfContext

WORD

lpContext パラメーターが指す構造体のサイズ (バイト単位)。lpContext の値が NULL 以外の場合、このパラメーターは 0 以外である必要があります。lpContext が NULL の場合、このパラメーターは 0 である必要があります。

lpSecurityAttributes

SECURITY_ATTRIBUTES*

inoptional

返されるハンドルを子プロセスが継承できるかどうかを決定する SECURITY_ATTRIBUTES 構造体へのポインター。SECURITY_ATTRIBUTES 構造体の詳細については、Microsoft Windows SDK のドキュメントを参照してください。このパラメーターは省略可能であり、NULL を指定できます。このパラメーターが NULL の場合、ハンドルは継承できません。

hPort

HANDLE*

out

FilterConnectCommunicationPort の呼び出しが成功した場合に、新しく作成された接続ポートのハンドルを受け取る、呼び出し元が割り当てた変数へのポインター。成功しなかった場合は INVALID_HANDLE_VALUE を受け取ります。

戻り値の型: HRESULT

公式ドキュメント

FilterConnectCommunicationPort は、ファイルシステムミニフィルターによって作成された通信サーバーポートへの新しい接続を開きます。

戻り値

FilterConnectCommunicationPort は、成功した場合は S_OK を返します。それ以外の場合はエラー値を返します。

解説(Remarks)

FilterConnectCommunicationPort は、ユーザーモードアプリケーションの代わりに、ミニフィルターの通信サーバーポートへの接続を開きます。アプリケーションは、得られた接続ポートのハンドルを使用してミニフィルターと通信します。

FilterConnectCommunicationPort の呼び出しに成功すると、アプリケーションは FilterSendMessage を呼び出すことで、接続ポートを通じてミニフィルターにメッセージを送信できます。また、FilterGetMessage と FilterReplyMessage を呼び出すことで、それぞれミニフィルターからのメッセージの受信と応答を行えます。hPort パラメーターに返される接続ポートのハンドルは、FilterSendMessage、FilterGetMessage、FilterReplyMessage の最初のパラメーターとして渡されます。

FilterConnectCommunicationPort から取得したハンドルは、最終的に CloseHandle を呼び出して解放する必要があります。

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "FLTLIB.dll"
#cfunc global FilterConnectCommunicationPort "FilterConnectCommunicationPort" wstr, int, sptr, int, sptr, sptr
; res = FilterConnectCommunicationPort(lpPortName, dwOptions, lpContext, wSizeOfContext, varptr(lpSecurityAttributes), hPort)
; lpPortName : LPCWSTR -> "wstr"
; dwOptions : DWORD -> "int"
; lpContext : void* optional -> "sptr"
; wSizeOfContext : WORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; hPort : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。