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

SetNamedPipeHandleState

関数
名前付きパイプハンドルの状態やモードを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetNamedPipeHandleState(
    HANDLE hNamedPipe,
    NAMED_PIPE_MODE* lpMode,   // optional
    DWORD* lpMaxCollectionCount,   // optional
    DWORD* lpCollectDataTimeout   // optional
);

パラメーター

名前方向
hNamedPipeHANDLEin
lpModeNAMED_PIPE_MODE*inoptional
lpMaxCollectionCountDWORD*inoptional
lpCollectDataTimeoutDWORD*inoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetNamedPipeHandleState = ctypes.windll.kernel32.SetNamedPipeHandleState
SetNamedPipeHandleState.restype = wintypes.BOOL
SetNamedPipeHandleState.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.c_void_p,  # lpMode : NAMED_PIPE_MODE* optional
    ctypes.POINTER(wintypes.DWORD),  # lpMaxCollectionCount : DWORD* optional
    ctypes.POINTER(wintypes.DWORD),  # lpCollectDataTimeout : DWORD* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetNamedPipeHandleState = Fiddle::Function.new(
  lib['SetNamedPipeHandleState'],
  [
    Fiddle::TYPE_VOIDP,  # hNamedPipe : HANDLE
    Fiddle::TYPE_VOIDP,  # lpMode : NAMED_PIPE_MODE* optional
    Fiddle::TYPE_VOIDP,  # lpMaxCollectionCount : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpCollectDataTimeout : DWORD* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetNamedPipeHandleState(
        hNamedPipe: *mut core::ffi::c_void,  // HANDLE
        lpMode: *mut u32,  // NAMED_PIPE_MODE* optional
        lpMaxCollectionCount: *mut u32,  // DWORD* optional
        lpCollectDataTimeout: *mut u32  // DWORD* optional
    ) -> 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 SetNamedPipeHandleState(IntPtr hNamedPipe, IntPtr lpMode, IntPtr lpMaxCollectionCount, IntPtr lpCollectDataTimeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetNamedPipeHandleState' -Namespace Win32 -PassThru
# $api::SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
#uselib "KERNEL32.dll"
#func global SetNamedPipeHandleState "SetNamedPipeHandleState" sptr, sptr, sptr, sptr
; SetNamedPipeHandleState hNamedPipe, lpMode, varptr(lpMaxCollectionCount), varptr(lpCollectDataTimeout)   ; 戻り値は stat
; hNamedPipe : HANDLE -> "sptr"
; lpMode : NAMED_PIPE_MODE* optional -> "sptr"
; lpMaxCollectionCount : DWORD* optional -> "sptr"
; lpCollectDataTimeout : DWORD* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetNamedPipeHandleState "SetNamedPipeHandleState" sptr, int, var, var
; res = SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
; hNamedPipe : HANDLE -> "sptr"
; lpMode : NAMED_PIPE_MODE* optional -> "int"
; lpMaxCollectionCount : DWORD* optional -> "var"
; lpCollectDataTimeout : DWORD* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetNamedPipeHandleState(HANDLE hNamedPipe, NAMED_PIPE_MODE* lpMode, DWORD* lpMaxCollectionCount, DWORD* lpCollectDataTimeout)
#uselib "KERNEL32.dll"
#cfunc global SetNamedPipeHandleState "SetNamedPipeHandleState" intptr, int, var, var
; res = SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
; hNamedPipe : HANDLE -> "intptr"
; lpMode : NAMED_PIPE_MODE* optional -> "int"
; lpMaxCollectionCount : DWORD* optional -> "var"
; lpCollectDataTimeout : DWORD* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetNamedPipeHandleState = kernel32.NewProc("SetNamedPipeHandleState")
)

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