ホーム › System.Pipes › GetNamedPipeHandleStateW

GetNamedPipeHandleStateW

関数

名前付きパイプハンドルの状態情報を取得する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetNamedPipeHandleStateW(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpState,   // optional
    DWORD* lpCurInstances,   // optional
    DWORD* lpMaxCollectionCount,   // optional
    DWORD* lpCollectDataTimeout,   // optional
    LPWSTR lpUserName,   // optional
    DWORD nMaxUserNameSize
);

パラメーター

名前	型	方向	説明
hNamedPipe	HANDLE	in	状態を取得する名前付きパイプのハンドルを指定する。
lpState	NAMED_PIPE_MODE*	outoptional	現在のパイプモード(読取モード/待機モード)を受け取る出力先。NULL可。
lpCurInstances	DWORD*	outoptional	現在のパイプインスタンス数を受け取る出力先。NULL可。
lpMaxCollectionCount	DWORD*	outoptional	リモート読取で蓄積する最大バイト数を受け取る出力先。NULL可。
lpCollectDataTimeout	DWORD*	outoptional	リモート読取の最大待機時間(ミリ秒)を受け取る出力先。NULL可。
lpUserName	LPWSTR	outoptional	クライアントのユーザー名(Unicode)を受け取るバッファ。サーバー側でのみ有効。NULL可。
nMaxUserNameSize	DWORD	in	lpUserNameバッファのサイズ(文字数)を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetNamedPipeHandleStateW(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpState,   // optional
    DWORD* lpCurInstances,   // optional
    DWORD* lpMaxCollectionCount,   // optional
    DWORD* lpCollectDataTimeout,   // optional
    LPWSTR lpUserName,   // optional
    DWORD nMaxUserNameSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetNamedPipeHandleStateW(
    IntPtr hNamedPipe,   // HANDLE
    IntPtr lpState,   // NAMED_PIPE_MODE* optional, out
    IntPtr lpCurInstances,   // DWORD* optional, out
    IntPtr lpMaxCollectionCount,   // DWORD* optional, out
    IntPtr lpCollectDataTimeout,   // DWORD* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpUserName,   // LPWSTR optional, out
    uint nMaxUserNameSize   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetNamedPipeHandleStateW(
    hNamedPipe As IntPtr,   ' HANDLE
    lpState As IntPtr,   ' NAMED_PIPE_MODE* optional, out
    lpCurInstances As IntPtr,   ' DWORD* optional, out
    lpMaxCollectionCount As IntPtr,   ' DWORD* optional, out
    lpCollectDataTimeout As IntPtr,   ' DWORD* optional, out
    <MarshalAs(UnmanagedType.LPWStr)> lpUserName As System.Text.StringBuilder,   ' LPWSTR optional, out
    nMaxUserNameSize As UInteger   ' DWORD
) As Boolean
End Function

' hNamedPipe : HANDLE
' lpState : NAMED_PIPE_MODE* optional, out
' lpCurInstances : DWORD* optional, out
' lpMaxCollectionCount : DWORD* optional, out
' lpCollectDataTimeout : DWORD* optional, out
' lpUserName : LPWSTR optional, out
' nMaxUserNameSize : DWORD
Declare PtrSafe Function GetNamedPipeHandleStateW Lib "kernel32" ( _
    ByVal hNamedPipe As LongPtr, _
    ByVal lpState As LongPtr, _
    ByVal lpCurInstances As LongPtr, _
    ByVal lpMaxCollectionCount As LongPtr, _
    ByVal lpCollectDataTimeout As LongPtr, _
    ByVal lpUserName As LongPtr, _
    ByVal nMaxUserNameSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNamedPipeHandleStateW = ctypes.windll.kernel32.GetNamedPipeHandleStateW
GetNamedPipeHandleStateW.restype = wintypes.BOOL
GetNamedPipeHandleStateW.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.c_void_p,  # lpState : NAMED_PIPE_MODE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpCurInstances : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpMaxCollectionCount : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpCollectDataTimeout : DWORD* optional, out
    wintypes.LPWSTR,  # lpUserName : LPWSTR optional, out
    wintypes.DWORD,  # nMaxUserNameSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNamedPipeHandleStateW = Fiddle::Function.new(
  lib['GetNamedPipeHandleStateW'],
  [
    Fiddle::TYPE_VOIDP,  # hNamedPipe : HANDLE
    Fiddle::TYPE_VOIDP,  # lpState : NAMED_PIPE_MODE* optional, out
    Fiddle::TYPE_VOIDP,  # lpCurInstances : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpMaxCollectionCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpCollectDataTimeout : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpUserName : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # nMaxUserNameSize : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetNamedPipeHandleStateW(
        hNamedPipe: *mut core::ffi::c_void,  // HANDLE
        lpState: *mut u32,  // NAMED_PIPE_MODE* optional, out
        lpCurInstances: *mut u32,  // DWORD* optional, out
        lpMaxCollectionCount: *mut u32,  // DWORD* optional, out
        lpCollectDataTimeout: *mut u32,  // DWORD* optional, out
        lpUserName: *mut u16,  // LPWSTR optional, out
        nMaxUserNameSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern bool GetNamedPipeHandleStateW(IntPtr hNamedPipe, IntPtr lpState, IntPtr lpCurInstances, IntPtr lpMaxCollectionCount, IntPtr lpCollectDataTimeout, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpUserName, uint nMaxUserNameSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNamedPipeHandleStateW' -Namespace Win32 -PassThru
# $api::GetNamedPipeHandleStateW(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)

#uselib "KERNEL32.dll"
#func global GetNamedPipeHandleStateW "GetNamedPipeHandleStateW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; GetNamedPipeHandleStateW hNamedPipe, lpState, varptr(lpCurInstances), varptr(lpMaxCollectionCount), varptr(lpCollectDataTimeout), varptr(lpUserName), nMaxUserNameSize   ; 戻り値は stat
; hNamedPipe : HANDLE -> "wptr"
; lpState : NAMED_PIPE_MODE* optional, out -> "wptr"
; lpCurInstances : DWORD* optional, out -> "wptr"
; lpMaxCollectionCount : DWORD* optional, out -> "wptr"
; lpCollectDataTimeout : DWORD* optional, out -> "wptr"
; lpUserName : LPWSTR optional, out -> "wptr"
; nMaxUserNameSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeHandleStateW "GetNamedPipeHandleStateW" sptr, int, var, var, var, var, int
; res = GetNamedPipeHandleStateW(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
; hNamedPipe : HANDLE -> "sptr"
; lpState : NAMED_PIPE_MODE* optional, out -> "int"
; lpCurInstances : DWORD* optional, out -> "var"
; lpMaxCollectionCount : DWORD* optional, out -> "var"
; lpCollectDataTimeout : DWORD* optional, out -> "var"
; lpUserName : LPWSTR optional, out -> "var"
; nMaxUserNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeHandleStateW "GetNamedPipeHandleStateW" sptr, int, sptr, sptr, sptr, sptr, int
; res = GetNamedPipeHandleStateW(hNamedPipe, lpState, varptr(lpCurInstances), varptr(lpMaxCollectionCount), varptr(lpCollectDataTimeout), varptr(lpUserName), nMaxUserNameSize)
; hNamedPipe : HANDLE -> "sptr"
; lpState : NAMED_PIPE_MODE* optional, out -> "int"
; lpCurInstances : DWORD* optional, out -> "sptr"
; lpMaxCollectionCount : DWORD* optional, out -> "sptr"
; lpCollectDataTimeout : DWORD* optional, out -> "sptr"
; lpUserName : LPWSTR optional, out -> "sptr"
; nMaxUserNameSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetNamedPipeHandleStateW(HANDLE hNamedPipe, NAMED_PIPE_MODE* lpState, DWORD* lpCurInstances, DWORD* lpMaxCollectionCount, DWORD* lpCollectDataTimeout, LPWSTR lpUserName, DWORD nMaxUserNameSize)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeHandleStateW "GetNamedPipeHandleStateW" intptr, int, var, var, var, var, int
; res = GetNamedPipeHandleStateW(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
; hNamedPipe : HANDLE -> "intptr"
; lpState : NAMED_PIPE_MODE* optional, out -> "int"
; lpCurInstances : DWORD* optional, out -> "var"
; lpMaxCollectionCount : DWORD* optional, out -> "var"
; lpCollectDataTimeout : DWORD* optional, out -> "var"
; lpUserName : LPWSTR optional, out -> "var"
; nMaxUserNameSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetNamedPipeHandleStateW(HANDLE hNamedPipe, NAMED_PIPE_MODE* lpState, DWORD* lpCurInstances, DWORD* lpMaxCollectionCount, DWORD* lpCollectDataTimeout, LPWSTR lpUserName, DWORD nMaxUserNameSize)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeHandleStateW "GetNamedPipeHandleStateW" intptr, int, intptr, intptr, intptr, intptr, int
; res = GetNamedPipeHandleStateW(hNamedPipe, lpState, varptr(lpCurInstances), varptr(lpMaxCollectionCount), varptr(lpCollectDataTimeout), varptr(lpUserName), nMaxUserNameSize)
; hNamedPipe : HANDLE -> "intptr"
; lpState : NAMED_PIPE_MODE* optional, out -> "int"
; lpCurInstances : DWORD* optional, out -> "intptr"
; lpMaxCollectionCount : DWORD* optional, out -> "intptr"
; lpCollectDataTimeout : DWORD* optional, out -> "intptr"
; lpUserName : LPWSTR optional, out -> "intptr"
; nMaxUserNameSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNamedPipeHandleStateW = kernel32.NewProc("GetNamedPipeHandleStateW")
)

// hNamedPipe (HANDLE), lpState (NAMED_PIPE_MODE* optional, out), lpCurInstances (DWORD* optional, out), lpMaxCollectionCount (DWORD* optional, out), lpCollectDataTimeout (DWORD* optional, out), lpUserName (LPWSTR optional, out), nMaxUserNameSize (DWORD)
r1, _, err := procGetNamedPipeHandleStateW.Call(
	uintptr(hNamedPipe),
	uintptr(lpState),
	uintptr(lpCurInstances),
	uintptr(lpMaxCollectionCount),
	uintptr(lpCollectDataTimeout),
	uintptr(lpUserName),
	uintptr(nMaxUserNameSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetNamedPipeHandleStateW(
  hNamedPipe: THandle;   // HANDLE
  lpState: Pointer;   // NAMED_PIPE_MODE* optional, out
  lpCurInstances: Pointer;   // DWORD* optional, out
  lpMaxCollectionCount: Pointer;   // DWORD* optional, out
  lpCollectDataTimeout: Pointer;   // DWORD* optional, out
  lpUserName: PWideChar;   // LPWSTR optional, out
  nMaxUserNameSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeHandleStateW';

result := DllCall("KERNEL32\GetNamedPipeHandleStateW"
    , "Ptr", hNamedPipe   ; HANDLE
    , "Ptr", lpState   ; NAMED_PIPE_MODE* optional, out
    , "Ptr", lpCurInstances   ; DWORD* optional, out
    , "Ptr", lpMaxCollectionCount   ; DWORD* optional, out
    , "Ptr", lpCollectDataTimeout   ; DWORD* optional, out
    , "Ptr", lpUserName   ; LPWSTR optional, out
    , "UInt", nMaxUserNameSize   ; DWORD
    , "Int")   ; return: BOOL

●GetNamedPipeHandleStateW(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize) = DLL("KERNEL32.dll", "bool GetNamedPipeHandleStateW(void*, void*, void*, void*, void*, char*, dword)")
# 呼び出し: GetNamedPipeHandleStateW(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
# hNamedPipe : HANDLE -> "void*"
# lpState : NAMED_PIPE_MODE* optional, out -> "void*"
# lpCurInstances : DWORD* optional, out -> "void*"
# lpMaxCollectionCount : DWORD* optional, out -> "void*"
# lpCollectDataTimeout : DWORD* optional, out -> "void*"
# lpUserName : LPWSTR optional, out -> "char*"
# nMaxUserNameSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。