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

GetNamedPipeInfo

関数
名前付きパイプの構成情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetNamedPipeInfo(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpFlags,   // optional
    DWORD* lpOutBufferSize,   // optional
    DWORD* lpInBufferSize,   // optional
    DWORD* lpMaxInstances   // optional
);

パラメーター

名前方向
hNamedPipeHANDLEin
lpFlagsNAMED_PIPE_MODE*outoptional
lpOutBufferSizeDWORD*outoptional
lpInBufferSizeDWORD*outoptional
lpMaxInstancesDWORD*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetNamedPipeInfo(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpFlags,   // optional
    DWORD* lpOutBufferSize,   // optional
    DWORD* lpInBufferSize,   // optional
    DWORD* lpMaxInstances   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNamedPipeInfo(
    IntPtr hNamedPipe,   // HANDLE
    IntPtr lpFlags,   // NAMED_PIPE_MODE* optional, out
    IntPtr lpOutBufferSize,   // DWORD* optional, out
    IntPtr lpInBufferSize,   // DWORD* optional, out
    IntPtr lpMaxInstances   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNamedPipeInfo(
    hNamedPipe As IntPtr,   ' HANDLE
    lpFlags As IntPtr,   ' NAMED_PIPE_MODE* optional, out
    lpOutBufferSize As IntPtr,   ' DWORD* optional, out
    lpInBufferSize As IntPtr,   ' DWORD* optional, out
    lpMaxInstances As IntPtr   ' DWORD* optional, out
) As Boolean
End Function
' hNamedPipe : HANDLE
' lpFlags : NAMED_PIPE_MODE* optional, out
' lpOutBufferSize : DWORD* optional, out
' lpInBufferSize : DWORD* optional, out
' lpMaxInstances : DWORD* optional, out
Declare PtrSafe Function GetNamedPipeInfo Lib "kernel32" ( _
    ByVal hNamedPipe As LongPtr, _
    ByVal lpFlags As LongPtr, _
    ByVal lpOutBufferSize As LongPtr, _
    ByVal lpInBufferSize As LongPtr, _
    ByVal lpMaxInstances As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNamedPipeInfo = ctypes.windll.kernel32.GetNamedPipeInfo
GetNamedPipeInfo.restype = wintypes.BOOL
GetNamedPipeInfo.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.c_void_p,  # lpFlags : NAMED_PIPE_MODE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpOutBufferSize : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpInBufferSize : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpMaxInstances : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNamedPipeInfo = Fiddle::Function.new(
  lib['GetNamedPipeInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hNamedPipe : HANDLE
    Fiddle::TYPE_VOIDP,  # lpFlags : NAMED_PIPE_MODE* optional, out
    Fiddle::TYPE_VOIDP,  # lpOutBufferSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpInBufferSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpMaxInstances : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetNamedPipeInfo(
        hNamedPipe: *mut core::ffi::c_void,  // HANDLE
        lpFlags: *mut u32,  // NAMED_PIPE_MODE* optional, out
        lpOutBufferSize: *mut u32,  // DWORD* optional, out
        lpInBufferSize: *mut u32,  // DWORD* optional, out
        lpMaxInstances: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetNamedPipeInfo(IntPtr hNamedPipe, IntPtr lpFlags, IntPtr lpOutBufferSize, IntPtr lpInBufferSize, IntPtr lpMaxInstances);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNamedPipeInfo' -Namespace Win32 -PassThru
# $api::GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
#uselib "KERNEL32.dll"
#func global GetNamedPipeInfo "GetNamedPipeInfo" sptr, sptr, sptr, sptr, sptr
; GetNamedPipeInfo hNamedPipe, lpFlags, varptr(lpOutBufferSize), varptr(lpInBufferSize), varptr(lpMaxInstances)   ; 戻り値は stat
; hNamedPipe : HANDLE -> "sptr"
; lpFlags : NAMED_PIPE_MODE* optional, out -> "sptr"
; lpOutBufferSize : DWORD* optional, out -> "sptr"
; lpInBufferSize : DWORD* optional, out -> "sptr"
; lpMaxInstances : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeInfo "GetNamedPipeInfo" sptr, int, var, var, var
; res = GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
; hNamedPipe : HANDLE -> "sptr"
; lpFlags : NAMED_PIPE_MODE* optional, out -> "int"
; lpOutBufferSize : DWORD* optional, out -> "var"
; lpInBufferSize : DWORD* optional, out -> "var"
; lpMaxInstances : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetNamedPipeInfo(HANDLE hNamedPipe, NAMED_PIPE_MODE* lpFlags, DWORD* lpOutBufferSize, DWORD* lpInBufferSize, DWORD* lpMaxInstances)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeInfo "GetNamedPipeInfo" intptr, int, var, var, var
; res = GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
; hNamedPipe : HANDLE -> "intptr"
; lpFlags : NAMED_PIPE_MODE* optional, out -> "int"
; lpOutBufferSize : DWORD* optional, out -> "var"
; lpInBufferSize : DWORD* optional, out -> "var"
; lpMaxInstances : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNamedPipeInfo = kernel32.NewProc("GetNamedPipeInfo")
)

// hNamedPipe (HANDLE), lpFlags (NAMED_PIPE_MODE* optional, out), lpOutBufferSize (DWORD* optional, out), lpInBufferSize (DWORD* optional, out), lpMaxInstances (DWORD* optional, out)
r1, _, err := procGetNamedPipeInfo.Call(
	uintptr(hNamedPipe),
	uintptr(lpFlags),
	uintptr(lpOutBufferSize),
	uintptr(lpInBufferSize),
	uintptr(lpMaxInstances),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetNamedPipeInfo(
  hNamedPipe: THandle;   // HANDLE
  lpFlags: Pointer;   // NAMED_PIPE_MODE* optional, out
  lpOutBufferSize: Pointer;   // DWORD* optional, out
  lpInBufferSize: Pointer;   // DWORD* optional, out
  lpMaxInstances: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeInfo';
result := DllCall("KERNEL32\GetNamedPipeInfo"
    , "Ptr", hNamedPipe   ; HANDLE
    , "Ptr", lpFlags   ; NAMED_PIPE_MODE* optional, out
    , "Ptr", lpOutBufferSize   ; DWORD* optional, out
    , "Ptr", lpInBufferSize   ; DWORD* optional, out
    , "Ptr", lpMaxInstances   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances) = DLL("KERNEL32.dll", "bool GetNamedPipeInfo(void*, void*, void*, void*, void*)")
# 呼び出し: GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
# hNamedPipe : HANDLE -> "void*"
# lpFlags : NAMED_PIPE_MODE* optional, out -> "void*"
# lpOutBufferSize : DWORD* optional, out -> "void*"
# lpInBufferSize : DWORD* optional, out -> "void*"
# lpMaxInstances : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。