GetNamedPipeInfo-Funktion (namedpipeapi.h)

Ruft Informationen zur angegebenen Named Pipe ab.

Syntax

BOOL GetNamedPipeInfo(
  [in]            HANDLE  hNamedPipe,
  [out, optional] LPDWORD lpFlags,
  [out, optional] LPDWORD lpOutBufferSize,
  [out, optional] LPDWORD lpInBufferSize,
  [out, optional] LPDWORD lpMaxInstances
);

Parameter

[in] hNamedPipe

Ein Handle für die named pipe instance. Das Handle muss GENERIC_READ Zugriff auf die benannte Pipe für eine schreibgeschützte Oder Lese-/Schreibpipe haben, oder es muss über GENERIC_WRITE und FILE_READ_ATTRIBUTES Zugriff für eine schreibgeschützte Pipe verfügen.

Dieser Parameter kann auch ein Handle für eine anonyme Pipe sein, wie von der CreatePipe-Funktion zurückgegeben.

[out, optional] lpFlags

Ein Zeiger auf eine Variable, die den Typ der benannten Pipe empfängt. Dieser Parameter kann NULL sein, wenn diese Informationen nicht erforderlich sind. Andernfalls kann es sich bei diesem Parameter um einen oder mehrere der folgenden Werte handeln.

Wert	Bedeutung
PIPE_CLIENT_END 0x00000000	Das Handle bezieht sich auf das Clientende einer Named Pipe-instance. Dies ist die Standardoption.
PIPE_SERVER_END 0x00000001	Das Handle bezieht sich auf das Serverende einer Named Pipe-instance. Wenn dieser Wert nicht angegeben wird, bezieht sich das Handle auf das Clientende einer Named Pipe-instance.
PIPE_TYPE_BYTE 0x00000000	Die benannte Pipe ist eine Bytepipe. Dies ist die Standardoption.
PIPE_TYPE_MESSAGE 0x00000004	Die Named Pipe ist eine Nachrichtenpipe. Wenn dieser Wert nicht angegeben wird, ist die Pipe eine Bytepipe.

[out, optional] lpOutBufferSize

Ein Zeiger auf eine Variable, die die Größe des Puffers für ausgehende Daten in Bytes empfängt. Wenn die Puffergröße null ist, wird der Puffer nach Bedarf zugeordnet. Dieser Parameter kann NULL sein, wenn diese Informationen nicht erforderlich sind.

[out, optional] lpInBufferSize

Ein Zeiger auf eine Variable, die die Größe des Puffers für eingehende Daten in Byte empfängt. Wenn die Puffergröße null ist, wird der Puffer nach Bedarf zugeordnet. Dieser Parameter kann NULL sein, wenn diese Informationen nicht erforderlich sind.

[out, optional] lpMaxInstances

Ein Zeiger auf eine Variable, die die maximale Anzahl von Pipeinstanzen empfängt, die erstellt werden können. Wenn die Variable auf PIPE_UNLIMITED_INSTANCES (255) festgelegt ist, wird die Anzahl der Pipeinstanzen, die erstellt werden können, nur durch die Verfügbarkeit von Systemressourcen begrenzt. Dieser Parameter kann NULL sein, wenn diese Informationen nicht erforderlich sind.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Windows 10 Version 1709: Pipes werden nur innerhalb eines App-Containers unterstützt, d. h. von einem UWP-Prozess zu einem anderen UWP-Prozess, der Teil derselben App ist. Außerdem müssen Named Pipes die Syntax "\\.\pipe\LOCAL\" für den Pipenamen verwenden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform	Windows
Kopfzeile	namedpipeapi.h
Bibliothek	Kernel32.lib
DLL	Kernel32.dll

Siehe auch

CreateNamedPipe

GetNamedPipeHandleState

Pipefunktionen

Übersicht über Pipes