WaitNamedPipeA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL WaitNamedPipeA(
LPCSTR lpNamedPipeName,
DWORD nTimeOut
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| lpNamedPipeName | LPCSTR | in | 名前付きパイプの名前です。この文字列には、サーバープロセスが実行されているコンピューターの名前を含める必要があります。パイプがローカルの場合は、servername にピリオドを使用できます。次のパイプ名形式を使用します。 \\servername\pipe\pipename | ||||||
| nTimeOut | DWORD | in | 名前付きパイプのインスタンスが利用可能になるまで関数が待機するミリ秒数です。ミリ秒数を指定する代わりに、次のいずれかの値を使用できます。
|
戻り値の型: BOOL
公式ドキュメント
WaitNamedPipeA (ANSI) 関数 (winbase.h) は、タイムアウト間隔が経過するか、指定した名前付きパイプのインスタンスが接続に利用可能になる (つまり、パイプのサーバープロセスがそのパイプに対して保留中の ConnectNamedPipe 操作を持つ) まで待機します。
戻り値
タイムアウト間隔が経過する前にパイプのインスタンスが利用可能になった場合、戻り値は 0 以外になります。
タイムアウト間隔が経過する前にパイプのインスタンスが利用可能にならなかった場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
指定した名前付きパイプのインスタンスが 1 つも存在しない場合、 WaitNamedPipe 関数はタイムアウト値に関係なく直ちに戻ります。
タイムアウト間隔が経過した場合、WaitNamedPipe 関数はエラー ERROR_SEM_TIMEOUT で失敗します。
関数が成功した場合、プロセスは CreateFile 関数を使用して、名前付きパイプへのハンドルを開く必要があります。戻り値が TRUE であることは、利用可能なパイプのインスタンスが少なくとも 1 つ存在することを示します。ただし、その後の CreateFile の呼び出しは、そのインスタンスがサーバーによって閉じられたり、別のクライアントによって開かれたりしたために失敗することがあります。
Windows 10, version 1709: パイプはアプリコンテナー内でのみサポートされます。つまり、ある UWP プロセスから、同じアプリの一部である別の UWP プロセスへの通信に限られます。また、名前付きパイプの名前には \\.\pipe\LOCAL\ という構文を使用する必要があります。
例
例については、 Named Pipe Client を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL WaitNamedPipeA(
LPCSTR lpNamedPipeName,
DWORD nTimeOut
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WaitNamedPipeA(
[MarshalAs(UnmanagedType.LPStr)] string lpNamedPipeName, // LPCSTR
uint nTimeOut // DWORD
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WaitNamedPipeA(
<MarshalAs(UnmanagedType.LPStr)> lpNamedPipeName As String, ' LPCSTR
nTimeOut As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpNamedPipeName : LPCSTR
' nTimeOut : DWORD
Declare PtrSafe Function WaitNamedPipeA Lib "kernel32" ( _
ByVal lpNamedPipeName As String, _
ByVal nTimeOut As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WaitNamedPipeA = ctypes.windll.kernel32.WaitNamedPipeA
WaitNamedPipeA.restype = wintypes.BOOL
WaitNamedPipeA.argtypes = [
wintypes.LPCSTR, # lpNamedPipeName : LPCSTR
wintypes.DWORD, # nTimeOut : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
WaitNamedPipeA = Fiddle::Function.new(
lib['WaitNamedPipeA'],
[
Fiddle::TYPE_VOIDP, # lpNamedPipeName : LPCSTR
-Fiddle::TYPE_INT, # nTimeOut : DWORD
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn WaitNamedPipeA(
lpNamedPipeName: *const u8, // LPCSTR
nTimeOut: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool WaitNamedPipeA([MarshalAs(UnmanagedType.LPStr)] string lpNamedPipeName, uint nTimeOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WaitNamedPipeA' -Namespace Win32 -PassThru
# $api::WaitNamedPipeA(lpNamedPipeName, nTimeOut)#uselib "KERNEL32.dll"
#func global WaitNamedPipeA "WaitNamedPipeA" sptr, sptr
; WaitNamedPipeA lpNamedPipeName, nTimeOut ; 戻り値は stat
; lpNamedPipeName : LPCSTR -> "sptr"
; nTimeOut : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global WaitNamedPipeA "WaitNamedPipeA" str, int
; res = WaitNamedPipeA(lpNamedPipeName, nTimeOut)
; lpNamedPipeName : LPCSTR -> "str"
; nTimeOut : DWORD -> "int"; BOOL WaitNamedPipeA(LPCSTR lpNamedPipeName, DWORD nTimeOut)
#uselib "KERNEL32.dll"
#cfunc global WaitNamedPipeA "WaitNamedPipeA" str, int
; res = WaitNamedPipeA(lpNamedPipeName, nTimeOut)
; lpNamedPipeName : LPCSTR -> "str"
; nTimeOut : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procWaitNamedPipeA = kernel32.NewProc("WaitNamedPipeA")
)
// lpNamedPipeName (LPCSTR), nTimeOut (DWORD)
r1, _, err := procWaitNamedPipeA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpNamedPipeName))),
uintptr(nTimeOut),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WaitNamedPipeA(
lpNamedPipeName: PAnsiChar; // LPCSTR
nTimeOut: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'WaitNamedPipeA';result := DllCall("KERNEL32\WaitNamedPipeA"
, "AStr", lpNamedPipeName ; LPCSTR
, "UInt", nTimeOut ; DWORD
, "Int") ; return: BOOL●WaitNamedPipeA(lpNamedPipeName, nTimeOut) = DLL("KERNEL32.dll", "bool WaitNamedPipeA(char*, dword)")
# 呼び出し: WaitNamedPipeA(lpNamedPipeName, nTimeOut)
# lpNamedPipeName : LPCSTR -> "char*"
# nTimeOut : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn WaitNamedPipeA(
lpNamedPipeName: [*c]const u8, // LPCSTR
nTimeOut: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc WaitNamedPipeA(
lpNamedPipeName: cstring, # LPCSTR
nTimeOut: uint32 # DWORD
): int32 {.importc: "WaitNamedPipeA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int WaitNamedPipeA(
const(char)* lpNamedPipeName, // LPCSTR
uint nTimeOut // DWORD
);ccall((:WaitNamedPipeA, "KERNEL32.dll"), stdcall, Int32,
(Cstring, UInt32),
lpNamedPipeName, nTimeOut)
# lpNamedPipeName : LPCSTR -> Cstring
# nTimeOut : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WaitNamedPipeA(
const char* lpNamedPipeName,
uint32_t nTimeOut);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WaitNamedPipeA(lpNamedPipeName, nTimeOut)
-- lpNamedPipeName : LPCSTR
-- nTimeOut : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WaitNamedPipeA = lib.func('__stdcall', 'WaitNamedPipeA', 'int32_t', ['str', 'uint32_t']);
// WaitNamedPipeA(lpNamedPipeName, nTimeOut)
// lpNamedPipeName : LPCSTR -> 'str'
// nTimeOut : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
WaitNamedPipeA: { parameters: ["buffer", "u32"], result: "i32" },
});
// lib.symbols.WaitNamedPipeA(lpNamedPipeName, nTimeOut)
// lpNamedPipeName : LPCSTR -> "buffer"
// nTimeOut : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WaitNamedPipeA(
const char* lpNamedPipeName,
uint32_t nTimeOut);
C, "KERNEL32.dll");
// $ffi->WaitNamedPipeA(lpNamedPipeName, nTimeOut);
// lpNamedPipeName : LPCSTR
// 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.ASCII_OPTIONS);
boolean WaitNamedPipeA(
String lpNamedPipeName, // LPCSTR
int nTimeOut // DWORD
);
}@[Link("kernel32")]
lib LibKERNEL32
fun WaitNamedPipeA = WaitNamedPipeA(
lpNamedPipeName : UInt8*, # LPCSTR
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 WaitNamedPipeANative = Int32 Function(Pointer<Utf8>, Uint32);
typedef WaitNamedPipeADart = int Function(Pointer<Utf8>, int);
final WaitNamedPipeA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<WaitNamedPipeANative, WaitNamedPipeADart>('WaitNamedPipeA');
// lpNamedPipeName : LPCSTR -> Pointer<Utf8>
// nTimeOut : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WaitNamedPipeA(
lpNamedPipeName: PAnsiChar; // LPCSTR
nTimeOut: DWORD // DWORD
): BOOL; stdcall;
external 'KERNEL32.dll' name 'WaitNamedPipeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WaitNamedPipeA"
c_WaitNamedPipeA :: CString -> Word32 -> IO CInt
-- lpNamedPipeName : LPCSTR -> CString
-- nTimeOut : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let waitnamedpipea =
foreign "WaitNamedPipeA"
(string @-> uint32_t @-> returning int32_t)
(* lpNamedPipeName : LPCSTR -> string *)
(* 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 ("WaitNamedPipeA" wait-named-pipe-a :convention :stdcall) :int32
(lp-named-pipe-name :string) ; LPCSTR
(n-time-out :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WaitNamedPipeA = Win32::API::More->new('KERNEL32',
'BOOL WaitNamedPipeA(LPCSTR lpNamedPipeName, DWORD nTimeOut)');
# my $ret = $WaitNamedPipeA->Call($lpNamedPipeName, $nTimeOut);
# lpNamedPipeName : LPCSTR -> LPCSTR
# nTimeOut : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WaitNamedPipeW (Unicode版) — 名前付きパイプが利用可能になるまで待機する。
- f CallNamedPipeA — 名前付きパイプへ接続し送受信を一括実行する(ANSI版)。
- f ConnectNamedPipe — 名前付きパイプサーバーがクライアント接続を待ち受ける。
- f CreateFileA — ファイルやデバイスを作成または開いてハンドルを返す(ANSI版)。
- f CreateNamedPipeA — 名前付きパイプのインスタンスを作成する(ANSI版)。