ホーム › System.Pipes › GetNamedPipeInfo
GetNamedPipeInfo
関数名前付きパイプの構成情報を取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetNamedPipeInfo(
HANDLE hNamedPipe,
NAMED_PIPE_MODE* lpFlags, // optional
DWORD* lpOutBufferSize, // optional
DWORD* lpInBufferSize, // optional
DWORD* lpMaxInstances // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hNamedPipe | HANDLE | in | 情報を取得する名前付きパイプのハンドルを指定する。 |
| lpFlags | NAMED_PIPE_MODE* | outoptional | サーバー/クライアント種別やパイプ型を示すフラグを受け取る出力先。NULL可。 |
| lpOutBufferSize | DWORD* | outoptional | 出力バッファのサイズ(バイト)を受け取る出力先。NULL可。 |
| lpInBufferSize | DWORD* | outoptional | 入力バッファのサイズ(バイト)を受け取る出力先。NULL可。 |
| lpMaxInstances | DWORD* | outoptional | 許可されている最大インスタンス数を受け取る出力先。NULL可。 |
戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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, varptr(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, var, var, var, var ; res = GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances) ; hNamedPipe : HANDLE -> "sptr" ; lpFlags : NAMED_PIPE_MODE* optional, out -> "var" ; lpOutBufferSize : DWORD* optional, out -> "var" ; lpInBufferSize : DWORD* optional, out -> "var" ; lpMaxInstances : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetNamedPipeInfo "GetNamedPipeInfo" sptr, sptr, sptr, sptr, sptr ; res = GetNamedPipeInfo(hNamedPipe, varptr(lpFlags), varptr(lpOutBufferSize), varptr(lpInBufferSize), varptr(lpMaxInstances)) ; 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" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL GetNamedPipeInfo(HANDLE hNamedPipe, NAMED_PIPE_MODE* lpFlags, DWORD* lpOutBufferSize, DWORD* lpInBufferSize, DWORD* lpMaxInstances) #uselib "KERNEL32.dll" #cfunc global GetNamedPipeInfo "GetNamedPipeInfo" intptr, var, var, var, var ; res = GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances) ; hNamedPipe : HANDLE -> "intptr" ; lpFlags : NAMED_PIPE_MODE* optional, out -> "var" ; 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, intptr, intptr, intptr, intptr ; res = GetNamedPipeInfo(hNamedPipe, varptr(lpFlags), varptr(lpOutBufferSize), varptr(lpInBufferSize), varptr(lpMaxInstances)) ; hNamedPipe : HANDLE -> "intptr" ; lpFlags : NAMED_PIPE_MODE* optional, out -> "intptr" ; lpOutBufferSize : DWORD* optional, out -> "intptr" ; lpInBufferSize : DWORD* optional, out -> "intptr" ; lpMaxInstances : DWORD* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // BOOLfunction 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)。const std = @import("std");
extern "kernel32" fn GetNamedPipeInfo(
hNamedPipe: ?*anyopaque, // HANDLE
lpFlags: [*c]u32, // NAMED_PIPE_MODE* optional, out
lpOutBufferSize: [*c]u32, // DWORD* optional, out
lpInBufferSize: [*c]u32, // DWORD* optional, out
lpMaxInstances: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;proc GetNamedPipeInfo(
hNamedPipe: pointer, # HANDLE
lpFlags: ptr uint32, # NAMED_PIPE_MODE* optional, out
lpOutBufferSize: ptr uint32, # DWORD* optional, out
lpInBufferSize: ptr uint32, # DWORD* optional, out
lpMaxInstances: ptr uint32 # DWORD* optional, out
): int32 {.importc: "GetNamedPipeInfo", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetNamedPipeInfo(
void* hNamedPipe, // HANDLE
uint* lpFlags, // NAMED_PIPE_MODE* optional, out
uint* lpOutBufferSize, // DWORD* optional, out
uint* lpInBufferSize, // DWORD* optional, out
uint* lpMaxInstances // DWORD* optional, out
);ccall((:GetNamedPipeInfo, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
# hNamedPipe : HANDLE -> Ptr{Cvoid}
# lpFlags : NAMED_PIPE_MODE* optional, out -> Ptr{UInt32}
# lpOutBufferSize : DWORD* optional, out -> Ptr{UInt32}
# lpInBufferSize : DWORD* optional, out -> Ptr{UInt32}
# lpMaxInstances : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetNamedPipeInfo(
void* hNamedPipe,
uint32_t* lpFlags,
uint32_t* lpOutBufferSize,
uint32_t* lpInBufferSize,
uint32_t* lpMaxInstances);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
-- hNamedPipe : HANDLE
-- lpFlags : NAMED_PIPE_MODE* optional, out
-- lpOutBufferSize : DWORD* optional, out
-- lpInBufferSize : DWORD* optional, out
-- lpMaxInstances : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetNamedPipeInfo = lib.func('__stdcall', 'GetNamedPipeInfo', 'int32_t', ['void *', 'uint32_t *', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
// hNamedPipe : HANDLE -> 'void *'
// lpFlags : NAMED_PIPE_MODE* optional, out -> 'uint32_t *'
// lpOutBufferSize : DWORD* optional, out -> 'uint32_t *'
// lpInBufferSize : DWORD* optional, out -> 'uint32_t *'
// lpMaxInstances : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetNamedPipeInfo: { parameters: ["pointer", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances)
// hNamedPipe : HANDLE -> "pointer"
// lpFlags : NAMED_PIPE_MODE* optional, out -> "pointer"
// lpOutBufferSize : DWORD* optional, out -> "pointer"
// lpInBufferSize : DWORD* optional, out -> "pointer"
// lpMaxInstances : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetNamedPipeInfo(
void* hNamedPipe,
uint32_t* lpFlags,
uint32_t* lpOutBufferSize,
uint32_t* lpInBufferSize,
uint32_t* lpMaxInstances);
C, "KERNEL32.dll");
// $ffi->GetNamedPipeInfo(hNamedPipe, lpFlags, lpOutBufferSize, lpInBufferSize, lpMaxInstances);
// hNamedPipe : HANDLE
// lpFlags : NAMED_PIPE_MODE* optional, out
// lpOutBufferSize : DWORD* optional, out
// lpInBufferSize : DWORD* optional, out
// lpMaxInstances : DWORD* optional, 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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
boolean GetNamedPipeInfo(
Pointer hNamedPipe, // HANDLE
IntByReference lpFlags, // NAMED_PIPE_MODE* optional, out
IntByReference lpOutBufferSize, // DWORD* optional, out
IntByReference lpInBufferSize, // DWORD* optional, out
IntByReference lpMaxInstances // DWORD* optional, out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetNamedPipeInfo = GetNamedPipeInfo(
hNamedPipe : Void*, # HANDLE
lpFlags : UInt32*, # NAMED_PIPE_MODE* optional, out
lpOutBufferSize : UInt32*, # DWORD* optional, out
lpInBufferSize : UInt32*, # DWORD* optional, out
lpMaxInstances : UInt32* # DWORD* optional, out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetNamedPipeInfoNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef GetNamedPipeInfoDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final GetNamedPipeInfo = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetNamedPipeInfoNative, GetNamedPipeInfoDart>('GetNamedPipeInfo');
// hNamedPipe : HANDLE -> Pointer<Void>
// lpFlags : NAMED_PIPE_MODE* optional, out -> Pointer<Uint32>
// lpOutBufferSize : DWORD* optional, out -> Pointer<Uint32>
// lpInBufferSize : DWORD* optional, out -> Pointer<Uint32>
// lpMaxInstances : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetNamedPipeInfo"
c_GetNamedPipeInfo :: Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- hNamedPipe : HANDLE -> Ptr ()
-- lpFlags : NAMED_PIPE_MODE* optional, out -> Ptr Word32
-- lpOutBufferSize : DWORD* optional, out -> Ptr Word32
-- lpInBufferSize : DWORD* optional, out -> Ptr Word32
-- lpMaxInstances : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getnamedpipeinfo =
foreign "GetNamedPipeInfo"
((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hNamedPipe : HANDLE -> (ptr void) *)
(* lpFlags : NAMED_PIPE_MODE* optional, out -> (ptr uint32_t) *)
(* lpOutBufferSize : DWORD* optional, out -> (ptr uint32_t) *)
(* lpInBufferSize : DWORD* optional, out -> (ptr uint32_t) *)
(* lpMaxInstances : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("GetNamedPipeInfo" get-named-pipe-info :convention :stdcall) :int32
(h-named-pipe :pointer) ; HANDLE
(lp-flags :pointer) ; NAMED_PIPE_MODE* optional, out
(lp-out-buffer-size :pointer) ; DWORD* optional, out
(lp-in-buffer-size :pointer) ; DWORD* optional, out
(lp-max-instances :pointer)) ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetNamedPipeInfo = Win32::API::More->new('KERNEL32',
'BOOL GetNamedPipeInfo(HANDLE hNamedPipe, LPVOID lpFlags, LPVOID lpOutBufferSize, LPVOID lpInBufferSize, LPVOID lpMaxInstances)');
# my $ret = $GetNamedPipeInfo->Call($hNamedPipe, $lpFlags, $lpOutBufferSize, $lpInBufferSize, $lpMaxInstances);
# hNamedPipe : HANDLE -> HANDLE
# lpFlags : NAMED_PIPE_MODE* optional, out -> LPVOID
# lpOutBufferSize : DWORD* optional, out -> LPVOID
# lpInBufferSize : DWORD* optional, out -> LPVOID
# lpMaxInstances : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型