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

WaitNamedPipeW

関数
名前付きパイプが利用可能になるまで待機する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL WaitNamedPipeW(
    LPCWSTR lpNamedPipeName,
    DWORD nTimeOut
);

パラメーター

名前方向説明
lpNamedPipeNameLPCWSTRin接続可能になるまで待機する名前付きパイプの名前(Unicode)を指定する。
nTimeOutDWORDin待機する最大時間(ミリ秒)。NMPWAIT_USE_DEFAULT_WAITやNMPWAIT_WAIT_FOREVER指定可。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL WaitNamedPipeW(
    LPCWSTR lpNamedPipeName,
    DWORD nTimeOut
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool WaitNamedPipeW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpNamedPipeName,   // LPCWSTR
    uint nTimeOut   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function WaitNamedPipeW(
    <MarshalAs(UnmanagedType.LPWStr)> lpNamedPipeName As String,   ' LPCWSTR
    nTimeOut As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpNamedPipeName : LPCWSTR
' nTimeOut : DWORD
Declare PtrSafe Function WaitNamedPipeW Lib "kernel32" ( _
    ByVal lpNamedPipeName As LongPtr, _
    ByVal nTimeOut As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WaitNamedPipeW = ctypes.windll.kernel32.WaitNamedPipeW
WaitNamedPipeW.restype = wintypes.BOOL
WaitNamedPipeW.argtypes = [
    wintypes.LPCWSTR,  # lpNamedPipeName : LPCWSTR
    wintypes.DWORD,  # nTimeOut : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WaitNamedPipeW = Fiddle::Function.new(
  lib['WaitNamedPipeW'],
  [
    Fiddle::TYPE_VOIDP,  # lpNamedPipeName : LPCWSTR
    -Fiddle::TYPE_INT,  # nTimeOut : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn WaitNamedPipeW(
        lpNamedPipeName: *const u16,  // LPCWSTR
        nTimeOut: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern bool WaitNamedPipeW([MarshalAs(UnmanagedType.LPWStr)] string lpNamedPipeName, uint nTimeOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WaitNamedPipeW' -Namespace Win32 -PassThru
# $api::WaitNamedPipeW(lpNamedPipeName, nTimeOut)
#uselib "KERNEL32.dll"
#func global WaitNamedPipeW "WaitNamedPipeW" wptr, wptr
; WaitNamedPipeW lpNamedPipeName, nTimeOut   ; 戻り値は stat
; lpNamedPipeName : LPCWSTR -> "wptr"
; nTimeOut : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global WaitNamedPipeW "WaitNamedPipeW" wstr, int
; res = WaitNamedPipeW(lpNamedPipeName, nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; nTimeOut : DWORD -> "int"
; BOOL WaitNamedPipeW(LPCWSTR lpNamedPipeName, DWORD nTimeOut)
#uselib "KERNEL32.dll"
#cfunc global WaitNamedPipeW "WaitNamedPipeW" wstr, int
; res = WaitNamedPipeW(lpNamedPipeName, nTimeOut)
; lpNamedPipeName : LPCWSTR -> "wstr"
; nTimeOut : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWaitNamedPipeW = kernel32.NewProc("WaitNamedPipeW")
)

// lpNamedPipeName (LPCWSTR), nTimeOut (DWORD)
r1, _, err := procWaitNamedPipeW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpNamedPipeName))),
	uintptr(nTimeOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WaitNamedPipeW(
  lpNamedPipeName: PWideChar;   // LPCWSTR
  nTimeOut: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WaitNamedPipeW';
result := DllCall("KERNEL32\WaitNamedPipeW"
    , "WStr", lpNamedPipeName   ; LPCWSTR
    , "UInt", nTimeOut   ; DWORD
    , "Int")   ; return: BOOL
●WaitNamedPipeW(lpNamedPipeName, nTimeOut) = DLL("KERNEL32.dll", "bool WaitNamedPipeW(char*, dword)")
# 呼び出し: WaitNamedPipeW(lpNamedPipeName, nTimeOut)
# lpNamedPipeName : LPCWSTR -> "char*"
# nTimeOut : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn WaitNamedPipeW(
    lpNamedPipeName: [*c]const u16, // LPCWSTR
    nTimeOut: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WaitNamedPipeW(
    lpNamedPipeName: WideCString,  # LPCWSTR
    nTimeOut: uint32  # DWORD
): int32 {.importc: "WaitNamedPipeW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int WaitNamedPipeW(
    const(wchar)* lpNamedPipeName,   // LPCWSTR
    uint nTimeOut   // DWORD
);
ccall((:WaitNamedPipeW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, UInt32),
      lpNamedPipeName, nTimeOut)
# lpNamedPipeName : LPCWSTR -> Cwstring
# nTimeOut : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WaitNamedPipeW(
    const uint16_t* lpNamedPipeName,
    uint32_t nTimeOut);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WaitNamedPipeW(lpNamedPipeName, nTimeOut)
-- lpNamedPipeName : LPCWSTR
-- nTimeOut : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WaitNamedPipeW = lib.func('__stdcall', 'WaitNamedPipeW', 'int32_t', ['str16', 'uint32_t']);
// WaitNamedPipeW(lpNamedPipeName, nTimeOut)
// lpNamedPipeName : LPCWSTR -> 'str16'
// nTimeOut : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WaitNamedPipeW: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.WaitNamedPipeW(lpNamedPipeName, nTimeOut)
// lpNamedPipeName : LPCWSTR -> "buffer"
// nTimeOut : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WaitNamedPipeW(
    const uint16_t* lpNamedPipeName,
    uint32_t nTimeOut);
C, "KERNEL32.dll");
// $ffi->WaitNamedPipeW(lpNamedPipeName, nTimeOut);
// lpNamedPipeName : LPCWSTR
// nTimeOut : 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.UNICODE_OPTIONS);
    boolean WaitNamedPipeW(
        WString lpNamedPipeName,   // LPCWSTR
        int nTimeOut   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun WaitNamedPipeW = WaitNamedPipeW(
    lpNamedPipeName : UInt16*,   # LPCWSTR
    nTimeOut : 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 WaitNamedPipeWNative = Int32 Function(Pointer<Utf16>, Uint32);
typedef WaitNamedPipeWDart = int Function(Pointer<Utf16>, int);
final WaitNamedPipeW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WaitNamedPipeWNative, WaitNamedPipeWDart>('WaitNamedPipeW');
// lpNamedPipeName : LPCWSTR -> Pointer<Utf16>
// nTimeOut : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WaitNamedPipeW(
  lpNamedPipeName: PWideChar;   // LPCWSTR
  nTimeOut: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WaitNamedPipeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WaitNamedPipeW"
  c_WaitNamedPipeW :: CWString -> Word32 -> IO CInt
-- lpNamedPipeName : LPCWSTR -> CWString
-- nTimeOut : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let waitnamedpipew =
  foreign "WaitNamedPipeW"
    ((ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* lpNamedPipeName : LPCWSTR -> (ptr uint16_t) *)
(* nTimeOut : 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 ("WaitNamedPipeW" wait-named-pipe-w :convention :stdcall) :int32
  (lp-named-pipe-name (:string :encoding :utf-16le))   ; LPCWSTR
  (n-time-out :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WaitNamedPipeW = Win32::API::More->new('KERNEL32',
    'BOOL WaitNamedPipeW(LPCWSTR lpNamedPipeName, DWORD nTimeOut)');
# my $ret = $WaitNamedPipeW->Call($lpNamedPipeName, $nTimeOut);
# lpNamedPipeName : LPCWSTR -> LPCWSTR
# nTimeOut : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い