ホーム › System.Pipes › GetNamedPipeHandleStateA

GetNamedPipeHandleStateA

関数

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

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL GetNamedPipeHandleStateA(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpState,   // optional
    DWORD* lpCurInstances,   // optional
    DWORD* lpMaxCollectionCount,   // optional
    DWORD* lpCollectDataTimeout,   // optional
    LPSTR 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	LPSTR	outoptional	クライアントのユーザー名(ANSI)を受け取るバッファ。サーバー側でのみ有効。NULL可。
nMaxUserNameSize	DWORD	in	lpUserNameバッファのサイズ(文字数)を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetNamedPipeHandleStateA(
    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.LPStr)] System.Text.StringBuilder lpUserName,   // LPSTR optional, out
    uint nMaxUserNameSize   // DWORD
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNamedPipeHandleStateA(
    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.LPStr)> lpUserName As System.Text.StringBuilder,   ' LPSTR optional, out
    nMaxUserNameSize As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hNamedPipe : HANDLE
' lpState : NAMED_PIPE_MODE* optional, out
' lpCurInstances : DWORD* optional, out
' lpMaxCollectionCount : DWORD* optional, out
' lpCollectDataTimeout : DWORD* optional, out
' lpUserName : LPSTR optional, out
' nMaxUserNameSize : DWORD
Declare PtrSafe Function GetNamedPipeHandleStateA 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 String, _
    ByVal nMaxUserNameSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNamedPipeHandleStateA = ctypes.windll.kernel32.GetNamedPipeHandleStateA
GetNamedPipeHandleStateA.restype = wintypes.BOOL
GetNamedPipeHandleStateA.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.LPSTR,  # lpUserName : LPSTR optional, out
    wintypes.DWORD,  # nMaxUserNameSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNamedPipeHandleStateA = Fiddle::Function.new(
  lib['GetNamedPipeHandleStateA'],
  [
    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 : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nMaxUserNameSize : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNamedPipeHandleStateA(
        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 u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool GetNamedPipeHandleStateA(IntPtr hNamedPipe, IntPtr lpState, IntPtr lpCurInstances, IntPtr lpMaxCollectionCount, IntPtr lpCollectDataTimeout, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpUserName, uint nMaxUserNameSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNamedPipeHandleStateA' -Namespace Win32 -PassThru
# $api::GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)

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

出力引数:

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

出力引数:

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNamedPipeHandleStateA = kernel32.NewProc("GetNamedPipeHandleStateA")
)

// hNamedPipe (HANDLE), lpState (NAMED_PIPE_MODE* optional, out), lpCurInstances (DWORD* optional, out), lpMaxCollectionCount (DWORD* optional, out), lpCollectDataTimeout (DWORD* optional, out), lpUserName (LPSTR optional, out), nMaxUserNameSize (DWORD)
r1, _, err := procGetNamedPipeHandleStateA.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 GetNamedPipeHandleStateA(
  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: PAnsiChar;   // LPSTR optional, out
  nMaxUserNameSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeHandleStateA';

result := DllCall("KERNEL32\GetNamedPipeHandleStateA"
    , "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   ; LPSTR optional, out
    , "UInt", nMaxUserNameSize   ; DWORD
    , "Int")   ; return: BOOL

●GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize) = DLL("KERNEL32.dll", "bool GetNamedPipeHandleStateA(void*, void*, void*, void*, void*, char*, dword)")
# 呼び出し: GetNamedPipeHandleStateA(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 : LPSTR optional, out -> "char*"
# nMaxUserNameSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn GetNamedPipeHandleStateA(
    hNamedPipe: ?*anyopaque, // HANDLE
    lpState: [*c]u32, // NAMED_PIPE_MODE* optional, out
    lpCurInstances: [*c]u32, // DWORD* optional, out
    lpMaxCollectionCount: [*c]u32, // DWORD* optional, out
    lpCollectDataTimeout: [*c]u32, // DWORD* optional, out
    lpUserName: [*c]u8, // LPSTR optional, out
    nMaxUserNameSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;

proc GetNamedPipeHandleStateA(
    hNamedPipe: pointer,  # HANDLE
    lpState: ptr uint32,  # NAMED_PIPE_MODE* optional, out
    lpCurInstances: ptr uint32,  # DWORD* optional, out
    lpMaxCollectionCount: ptr uint32,  # DWORD* optional, out
    lpCollectDataTimeout: ptr uint32,  # DWORD* optional, out
    lpUserName: ptr char,  # LPSTR optional, out
    nMaxUserNameSize: uint32  # DWORD
): int32 {.importc: "GetNamedPipeHandleStateA", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int GetNamedPipeHandleStateA(
    void* hNamedPipe,   // HANDLE
    uint* lpState,   // NAMED_PIPE_MODE* optional, out
    uint* lpCurInstances,   // DWORD* optional, out
    uint* lpMaxCollectionCount,   // DWORD* optional, out
    uint* lpCollectDataTimeout,   // DWORD* optional, out
    char* lpUserName,   // LPSTR optional, out
    uint nMaxUserNameSize   // DWORD
);

ccall((:GetNamedPipeHandleStateA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt8}, UInt32),
      hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
# hNamedPipe : HANDLE -> Ptr{Cvoid}
# lpState : NAMED_PIPE_MODE* optional, out -> Ptr{UInt32}
# lpCurInstances : DWORD* optional, out -> Ptr{UInt32}
# lpMaxCollectionCount : DWORD* optional, out -> Ptr{UInt32}
# lpCollectDataTimeout : DWORD* optional, out -> Ptr{UInt32}
# lpUserName : LPSTR optional, out -> Ptr{UInt8}
# nMaxUserNameSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t GetNamedPipeHandleStateA(
    void* hNamedPipe,
    uint32_t* lpState,
    uint32_t* lpCurInstances,
    uint32_t* lpMaxCollectionCount,
    uint32_t* lpCollectDataTimeout,
    char* lpUserName,
    uint32_t nMaxUserNameSize);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
-- hNamedPipe : HANDLE
-- lpState : NAMED_PIPE_MODE* optional, out
-- lpCurInstances : DWORD* optional, out
-- lpMaxCollectionCount : DWORD* optional, out
-- lpCollectDataTimeout : DWORD* optional, out
-- lpUserName : LPSTR optional, out
-- nMaxUserNameSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetNamedPipeHandleStateA = lib.func('__stdcall', 'GetNamedPipeHandleStateA', 'int32_t', ['void *', 'uint32_t *', 'uint32_t *', 'uint32_t *', 'uint32_t *', 'char *', 'uint32_t']);
// GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
// hNamedPipe : HANDLE -> 'void *'
// lpState : NAMED_PIPE_MODE* optional, out -> 'uint32_t *'
// lpCurInstances : DWORD* optional, out -> 'uint32_t *'
// lpMaxCollectionCount : DWORD* optional, out -> 'uint32_t *'
// lpCollectDataTimeout : DWORD* optional, out -> 'uint32_t *'
// lpUserName : LPSTR optional, out -> 'char *'
// nMaxUserNameSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  GetNamedPipeHandleStateA: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize)
// hNamedPipe : HANDLE -> "pointer"
// lpState : NAMED_PIPE_MODE* optional, out -> "pointer"
// lpCurInstances : DWORD* optional, out -> "pointer"
// lpMaxCollectionCount : DWORD* optional, out -> "pointer"
// lpCollectDataTimeout : DWORD* optional, out -> "pointer"
// lpUserName : LPSTR optional, out -> "buffer"
// nMaxUserNameSize : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t GetNamedPipeHandleStateA(
    void* hNamedPipe,
    uint32_t* lpState,
    uint32_t* lpCurInstances,
    uint32_t* lpMaxCollectionCount,
    uint32_t* lpCollectDataTimeout,
    char* lpUserName,
    uint32_t nMaxUserNameSize);
C, "KERNEL32.dll");
// $ffi->GetNamedPipeHandleStateA(hNamedPipe, lpState, lpCurInstances, lpMaxCollectionCount, lpCollectDataTimeout, lpUserName, nMaxUserNameSize);
// hNamedPipe : HANDLE
// lpState : NAMED_PIPE_MODE* optional, out
// lpCurInstances : DWORD* optional, out
// lpMaxCollectionCount : DWORD* optional, out
// lpCollectDataTimeout : DWORD* optional, out
// lpUserName : LPSTR optional, out
// nMaxUserNameSize : DWORD
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean GetNamedPipeHandleStateA(
        Pointer hNamedPipe,   // HANDLE
        IntByReference lpState,   // NAMED_PIPE_MODE* optional, out
        IntByReference lpCurInstances,   // DWORD* optional, out
        IntByReference lpMaxCollectionCount,   // DWORD* optional, out
        IntByReference lpCollectDataTimeout,   // DWORD* optional, out
        byte[] lpUserName,   // LPSTR optional, out
        int nMaxUserNameSize   // DWORD
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun GetNamedPipeHandleStateA = GetNamedPipeHandleStateA(
    hNamedPipe : Void*,   # HANDLE
    lpState : UInt32*,   # NAMED_PIPE_MODE* optional, out
    lpCurInstances : UInt32*,   # DWORD* optional, out
    lpMaxCollectionCount : UInt32*,   # DWORD* optional, out
    lpCollectDataTimeout : UInt32*,   # DWORD* optional, out
    lpUserName : UInt8*,   # LPSTR optional, out
    nMaxUserNameSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetNamedPipeHandleStateANative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Utf8>, Uint32);
typedef GetNamedPipeHandleStateADart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Utf8>, int);
final GetNamedPipeHandleStateA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetNamedPipeHandleStateANative, GetNamedPipeHandleStateADart>('GetNamedPipeHandleStateA');
// hNamedPipe : HANDLE -> Pointer<Void>
// lpState : NAMED_PIPE_MODE* optional, out -> Pointer<Uint32>
// lpCurInstances : DWORD* optional, out -> Pointer<Uint32>
// lpMaxCollectionCount : DWORD* optional, out -> Pointer<Uint32>
// lpCollectDataTimeout : DWORD* optional, out -> Pointer<Uint32>
// lpUserName : LPSTR optional, out -> Pointer<Utf8>
// nMaxUserNameSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function GetNamedPipeHandleStateA(
  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: PAnsiChar;   // LPSTR optional, out
  nMaxUserNameSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeHandleStateA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNamedPipeHandleStateA"
  c_GetNamedPipeHandleStateA :: Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> CString -> Word32 -> IO CInt
-- hNamedPipe : HANDLE -> Ptr ()
-- lpState : NAMED_PIPE_MODE* optional, out -> Ptr Word32
-- lpCurInstances : DWORD* optional, out -> Ptr Word32
-- lpMaxCollectionCount : DWORD* optional, out -> Ptr Word32
-- lpCollectDataTimeout : DWORD* optional, out -> Ptr Word32
-- lpUserName : LPSTR optional, out -> CString
-- nMaxUserNameSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let getnamedpipehandlestatea =
  foreign "GetNamedPipeHandleStateA"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> string @-> uint32_t @-> returning int32_t)
(* hNamedPipe : HANDLE -> (ptr void) *)
(* lpState : NAMED_PIPE_MODE* optional, out -> (ptr uint32_t) *)
(* lpCurInstances : DWORD* optional, out -> (ptr uint32_t) *)
(* lpMaxCollectionCount : DWORD* optional, out -> (ptr uint32_t) *)
(* lpCollectDataTimeout : DWORD* optional, out -> (ptr uint32_t) *)
(* lpUserName : LPSTR optional, out -> string *)
(* nMaxUserNameSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetNamedPipeHandleStateA" get-named-pipe-handle-state-a :convention :stdcall) :int32
  (h-named-pipe :pointer)   ; HANDLE
  (lp-state :pointer)   ; NAMED_PIPE_MODE* optional, out
  (lp-cur-instances :pointer)   ; DWORD* optional, out
  (lp-max-collection-count :pointer)   ; DWORD* optional, out
  (lp-collect-data-timeout :pointer)   ; DWORD* optional, out
  (lp-user-name :pointer)   ; LPSTR optional, out
  (n-max-user-name-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $GetNamedPipeHandleStateA = Win32::API::More->new('KERNEL32',
    'BOOL GetNamedPipeHandleStateA(HANDLE hNamedPipe, LPVOID lpState, LPVOID lpCurInstances, LPVOID lpMaxCollectionCount, LPVOID lpCollectDataTimeout, LPSTR lpUserName, DWORD nMaxUserNameSize)');
# my $ret = $GetNamedPipeHandleStateA->Call($hNamedPipe, $lpState, $lpCurInstances, $lpMaxCollectionCount, $lpCollectDataTimeout, $lpUserName, $nMaxUserNameSize);
# hNamedPipe : HANDLE -> HANDLE
# lpState : NAMED_PIPE_MODE* optional, out -> LPVOID
# lpCurInstances : DWORD* optional, out -> LPVOID
# lpMaxCollectionCount : DWORD* optional, out -> LPVOID
# lpCollectDataTimeout : DWORD* optional, out -> LPVOID
# lpUserName : LPSTR optional, out -> LPSTR
# nMaxUserNameSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

GetNamedPipeHandleStateA

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目