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

ConnectNamedPipe

関数
名前付きパイプサーバーがクライアント接続を待ち受ける。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL ConnectNamedPipe(
    HANDLE hNamedPipe,
    OVERLAPPED* lpOverlapped   // optional
);

パラメーター

名前型方向説明
hNamedPipeHANDLEin名前付きパイプインスタンスのサーバー側のハンドル。このハンドルは CreateNamedPipe 関数によって返されます。
lpOverlappedOVERLAPPED*inoutoptional

OVERLAPPED 構造体へのポインター。

hNamedPipe が FILE_FLAG_OVERLAPPED を指定して開かれた場合、lpOverlapped パラメーターを NULL にすることはできません。有効な OVERLAPPED 構造体を指している必要があります。hNamedPipe が FILE_FLAG_OVERLAPPED を指定して開かれ、かつ lpOverlapped が NULL の場合、この関数は接続操作が完了したと誤って報告することがあります。

hNamedPipe が FILE_FLAG_OVERLAPPED を指定して作成され、かつ lpOverlapped が NULL でない場合、OVERLAPPED 構造体には、手動リセットイベントオブジェクトのハンドルを格納する必要があります (サーバーは CreateEvent 関数を使用して作成できます)。

hNamedPipe が FILE_FLAG_OVERLAPPED を指定せずに開かれた場合、この関数はクライアントが接続するか、エラーが発生するまで戻りません。同期操作が成功した場合、関数の呼び出し後にクライアントが接続すると、この関数は 0 以外の値を返します。

戻り値の型: BOOL

公式ドキュメント

名前付きパイプのサーバープロセスが、名前付きパイプのインスタンスへのクライアントプロセスの接続を待機できるようにします。

戻り値

操作が同期の場合、ConnectNamedPipe は操作が完了するまで戻りません。関数が成功すると、戻り値は 0 以外の値です。関数が失敗すると、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

操作が非同期の場合、ConnectNamedPipe は直ちに戻ります。操作がまだ保留中の場合、戻り値は 0 で、GetLastError は ERROR_IO_PENDING を返します。(操作が完了した時点を判断するには、HasOverlappedIoCompleted マクロを使用できます。) 関数が失敗した場合、戻り値は 0 で、 GetLastError は ERROR_IO_PENDING と ERROR_PIPE_CONNECTED 以外の値を返します。

関数が呼び出される前にクライアントが接続した場合、関数は 0 を返し、GetLastError は ERROR_PIPE_CONNECTED を返します。これは、 CreateNamedPipe の呼び出しから ConnectNamedPipe の呼び出しまでの間にクライアントが接続した場合に発生することがあります。この場合、関数が 0 を返しても、クライアントとサーバーの間には正常な接続が確立されています。

解説(Remarks)

名前付きパイプのサーバープロセスは、新しく作成したパイプインスタンスに対して ConnectNamedPipe を使用できます。また、以前に別のクライアントプロセスに接続されていたインスタンスに対して使用することもできます。この場合、サーバープロセスは、ハンドルを新しいクライアントに再接続する前に、まず DisconnectNamedPipe 関数を呼び出して、以前のクライアントからハンドルを切断する必要があります。そうしないと、 ConnectNamedPipe は 0 を返し、GetLastError は、以前のクライアントが自身のハンドルを閉じている場合は ERROR_NO_DATA を、閉じていない場合は ERROR_PIPE_CONNECTED を返します。

ConnectNamedPipe の動作は、2 つの条件によって決まります。すなわち、パイプハンドルの待機モードがブロッキングと非ブロッキングのどちらに設定されているか、および関数が同期モードとオーバーラップモードのどちらで実行されるように設定されているかです。サーバーは、最初に CreateNamedPipe 関数でパイプハンドルの待機モードを指定します。この設定は SetNamedPipeHandleState 関数を使用して変更できます。

サーバープロセスは、任意の 待機関数または SleepEx を使用して、イベントオブジェクトの状態がシグナル状態になった時点を判断できます。その後、HasOverlappedIoCompleted マクロを使用して、 ConnectNamedPipe 操作が完了した時点を判断できます。

指定したパイプハンドルが非ブロッキングモードの場合、 ConnectNamedPipe は常に直ちに戻ります。非ブロッキングモードでは、以前のクライアントから切断されたパイプインスタンスに対して初めて呼び出されたとき、 ConnectNamedPipe は 0 以外の値を返します。これは、そのパイプが新しいクライアントプロセスと接続できる状態になったことを示します。パイプハンドルが非ブロッキングモードのその他のすべての状況では、 ConnectNamedPipe は 0 を返します。これらの状況では、GetLastError は、クライアントが接続されていない場合は ERROR_PIPE_LISTENING を、クライアントが接続されている場合は ERROR_PIPE_CONNECTED を、以前のクライアントが自身のパイプハンドルを閉じたにもかかわらずサーバーが切断していない場合は ERROR_NO_DATA を返します。クライアントとサーバーの間の正常な接続は、ERROR_PIPE_CONNECTED エラーを受け取った後にのみ成立することに注意してください。

メモ 非ブロッキングモードは Microsoft LAN Manager バージョン 2.0 との互換性のためにサポートされているものであり、名前付きパイプで非同期の入出力 (I/O) を実現するために使用しないでください。
Windows 10 バージョン 1709 以降: パイプをアプリコンテナー間の通信に使用することはできません。つまり、ある UWP プロセスから、同じアプリの一部ではない別の UWP プロセスへの通信には使用できません。また、アプリコンテナー内の名前付きパイプでは、パイプ名に `\\.\pipe\LOCAL\` という構文を使用する必要があります。

例

例については、 マルチスレッドパイプサーバーを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

ConnectNamedPipe = ctypes.windll.kernel32.ConnectNamedPipe
ConnectNamedPipe.restype = wintypes.BOOL
ConnectNamedPipe.argtypes = [
    wintypes.HANDLE,  # hNamedPipe : HANDLE
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procConnectNamedPipe = kernel32.NewProc("ConnectNamedPipe")
)

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

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

typedef ConnectNamedPipeNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ConnectNamedPipeDart = int Function(Pointer<Void>, Pointer<Void>);
final ConnectNamedPipe = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ConnectNamedPipeNative, ConnectNamedPipeDart>('ConnectNamedPipe');
// hNamedPipe : HANDLE -> Pointer<Void>
// lpOverlapped : OVERLAPPED* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ConnectNamedPipe(
  hNamedPipe: THandle;   // HANDLE
  lpOverlapped: Pointer   // OVERLAPPED* optional, in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ConnectNamedPipe';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ConnectNamedPipe"
  c_ConnectNamedPipe :: Ptr () -> Ptr () -> IO CInt
-- hNamedPipe : HANDLE -> Ptr ()
-- lpOverlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let connectnamedpipe =
  foreign "ConnectNamedPipe"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hNamedPipe : HANDLE -> (ptr void) *)
(* lpOverlapped : OVERLAPPED* optional, in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ConnectNamedPipe" connect-named-pipe :convention :stdcall) :int32
  (h-named-pipe :pointer)   ; HANDLE
  (lp-overlapped :pointer))   ; OVERLAPPED* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ConnectNamedPipe = Win32::API::More->new('KERNEL32',
    'BOOL ConnectNamedPipe(HANDLE hNamedPipe, LPVOID lpOverlapped)');
# my $ret = $ConnectNamedPipe->Call($hNamedPipe, $lpOverlapped);
# hNamedPipe : HANDLE -> HANDLE
# lpOverlapped : OVERLAPPED* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型