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読み取りモードやブロッキング/非ブロッキング等を示す新しいモード値へのポインタ。NULLで変更なし。
lpMaxCollectionCountDWORD*inoptionalリモート読取で蓄積する最大バイト数へのポインタ。NULLで変更なし。
lpCollectDataTimeoutDWORD*inoptionalリモート読取の最大待機時間(ミリ秒)へのポインタ。NULLで変更なし。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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, varptr(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, var, var, var
; res = SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
; hNamedPipe : HANDLE -> "sptr"
; lpMode : NAMED_PIPE_MODE* optional -> "var"
; 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, var, var, var
; res = SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
; hNamedPipe : HANDLE -> "intptr"
; lpMode : NAMED_PIPE_MODE* optional -> "var"
; 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)。
const std = @import("std");

extern "kernel32" fn SetNamedPipeHandleState(
    hNamedPipe: ?*anyopaque, // HANDLE
    lpMode: [*c]u32, // NAMED_PIPE_MODE* optional
    lpMaxCollectionCount: [*c]u32, // DWORD* optional
    lpCollectDataTimeout: [*c]u32 // DWORD* optional
) callconv(std.os.windows.WINAPI) i32;
proc SetNamedPipeHandleState(
    hNamedPipe: pointer,  # HANDLE
    lpMode: ptr uint32,  # NAMED_PIPE_MODE* optional
    lpMaxCollectionCount: ptr uint32,  # DWORD* optional
    lpCollectDataTimeout: ptr uint32  # DWORD* optional
): int32 {.importc: "SetNamedPipeHandleState", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetNamedPipeHandleState(
    void* hNamedPipe,   // HANDLE
    uint* lpMode,   // NAMED_PIPE_MODE* optional
    uint* lpMaxCollectionCount,   // DWORD* optional
    uint* lpCollectDataTimeout   // DWORD* optional
);
ccall((:SetNamedPipeHandleState, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
      hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
# hNamedPipe : HANDLE -> Ptr{Cvoid}
# lpMode : NAMED_PIPE_MODE* optional -> Ptr{UInt32}
# lpMaxCollectionCount : DWORD* optional -> Ptr{UInt32}
# lpCollectDataTimeout : DWORD* optional -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetNamedPipeHandleState(
    void* hNamedPipe,
    uint32_t* lpMode,
    uint32_t* lpMaxCollectionCount,
    uint32_t* lpCollectDataTimeout);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
-- hNamedPipe : HANDLE
-- lpMode : NAMED_PIPE_MODE* optional
-- lpMaxCollectionCount : DWORD* optional
-- lpCollectDataTimeout : DWORD* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetNamedPipeHandleState = lib.func('__stdcall', 'SetNamedPipeHandleState', 'int32_t', ['void *', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
// hNamedPipe : HANDLE -> 'void *'
// lpMode : NAMED_PIPE_MODE* optional -> 'uint32_t *'
// lpMaxCollectionCount : DWORD* optional -> 'uint32_t *'
// lpCollectDataTimeout : DWORD* optional -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetNamedPipeHandleState: { parameters: ["pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout)
// hNamedPipe : HANDLE -> "pointer"
// lpMode : NAMED_PIPE_MODE* optional -> "pointer"
// lpMaxCollectionCount : DWORD* optional -> "pointer"
// lpCollectDataTimeout : DWORD* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetNamedPipeHandleState(
    void* hNamedPipe,
    uint32_t* lpMode,
    uint32_t* lpMaxCollectionCount,
    uint32_t* lpCollectDataTimeout);
C, "KERNEL32.dll");
// $ffi->SetNamedPipeHandleState(hNamedPipe, lpMode, lpMaxCollectionCount, lpCollectDataTimeout);
// hNamedPipe : HANDLE
// lpMode : NAMED_PIPE_MODE* optional
// lpMaxCollectionCount : DWORD* optional
// lpCollectDataTimeout : DWORD* optional
// 構造体/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 SetNamedPipeHandleState(
        Pointer hNamedPipe,   // HANDLE
        IntByReference lpMode,   // NAMED_PIPE_MODE* optional
        IntByReference lpMaxCollectionCount,   // DWORD* optional
        IntByReference lpCollectDataTimeout   // DWORD* optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetNamedPipeHandleState = SetNamedPipeHandleState(
    hNamedPipe : Void*,   # HANDLE
    lpMode : UInt32*,   # NAMED_PIPE_MODE* optional
    lpMaxCollectionCount : UInt32*,   # DWORD* optional
    lpCollectDataTimeout : UInt32*   # DWORD* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetNamedPipeHandleStateNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef SetNamedPipeHandleStateDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final SetNamedPipeHandleState = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetNamedPipeHandleStateNative, SetNamedPipeHandleStateDart>('SetNamedPipeHandleState');
// hNamedPipe : HANDLE -> Pointer<Void>
// lpMode : NAMED_PIPE_MODE* optional -> Pointer<Uint32>
// lpMaxCollectionCount : DWORD* optional -> Pointer<Uint32>
// lpCollectDataTimeout : DWORD* optional -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetNamedPipeHandleState"
  c_SetNamedPipeHandleState :: Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- hNamedPipe : HANDLE -> Ptr ()
-- lpMode : NAMED_PIPE_MODE* optional -> Ptr Word32
-- lpMaxCollectionCount : DWORD* optional -> Ptr Word32
-- lpCollectDataTimeout : DWORD* optional -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setnamedpipehandlestate =
  foreign "SetNamedPipeHandleState"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hNamedPipe : HANDLE -> (ptr void) *)
(* lpMode : NAMED_PIPE_MODE* optional -> (ptr uint32_t) *)
(* lpMaxCollectionCount : DWORD* optional -> (ptr uint32_t) *)
(* lpCollectDataTimeout : DWORD* optional -> (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 ("SetNamedPipeHandleState" set-named-pipe-handle-state :convention :stdcall) :int32
  (h-named-pipe :pointer)   ; HANDLE
  (lp-mode :pointer)   ; NAMED_PIPE_MODE* optional
  (lp-max-collection-count :pointer)   ; DWORD* optional
  (lp-collect-data-timeout :pointer))   ; DWORD* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetNamedPipeHandleState = Win32::API::More->new('KERNEL32',
    'BOOL SetNamedPipeHandleState(HANDLE hNamedPipe, LPVOID lpMode, LPVOID lpMaxCollectionCount, LPVOID lpCollectDataTimeout)');
# my $ret = $SetNamedPipeHandleState->Call($hNamedPipe, $lpMode, $lpMaxCollectionCount, $lpCollectDataTimeout);
# hNamedPipe : HANDLE -> HANDLE
# lpMode : NAMED_PIPE_MODE* optional -> LPVOID
# lpMaxCollectionCount : DWORD* optional -> LPVOID
# lpCollectDataTimeout : DWORD* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型