Compartir a través de

Función GetNamedPipeInfo (namedpipeapi.h)

  • Artículo

Recupera información sobre la canalización con nombre especificada.

Sintaxis

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

Parámetros

[in] hNamedPipe

Identificador de la instancia de canalización con nombre. El identificador debe tener GENERIC_READ acceso a la canalización con nombre para una canalización de solo lectura o de lectura y escritura, o bien debe tener GENERIC_WRITE y FILE_READ_ATTRIBUTES acceso para una canalización de solo escritura.

Este parámetro también puede ser un identificador de una canalización anónima, tal y como devuelve la función CreatePipe .

[out, optional] lpFlags

Puntero a una variable que recibe el tipo de la canalización con nombre. Este parámetro puede ser NULL si esta información no es necesaria. De lo contrario, este parámetro puede ser uno o varios de los valores siguientes.

Valor Significado
PIPE_CLIENT_END
0x00000000
 El identificador hace referencia al final del cliente de una instancia de canalización con nombre. Este es el valor predeterminado.
PIPE_SERVER_END
0x00000001
 El identificador hace referencia al final del servidor de una instancia de canalización con nombre. Si no se especifica este valor, el identificador hace referencia al final del cliente de una instancia de canalización con nombre.
PIPE_TYPE_BYTE
0x00000000
 La canalización con nombre es una canalización de bytes. Este es el valor predeterminado.
PIPE_TYPE_MESSAGE
0x00000004
 La canalización con nombre es una canalización de mensajes. Si no se especifica este valor, la canalización es una canalización de bytes.

[out, optional] lpOutBufferSize

Puntero a una variable que recibe el tamaño del búfer para los datos salientes, en bytes. Si el tamaño del búfer es cero, el búfer se asigna según sea necesario. Este parámetro puede ser NULL si esta información no es necesaria.

[out, optional] lpInBufferSize

Puntero a una variable que recibe el tamaño del búfer para los datos entrantes, en bytes. Si el tamaño del búfer es cero, el búfer se asigna según sea necesario. Este parámetro puede ser NULL si esta información no es necesaria.

[out, optional] lpMaxInstances

Puntero a una variable que recibe el número máximo de instancias de canalización que se pueden crear. Si la variable se establece en PIPE_UNLIMITED_INSTANCES (255), el número de instancias de canalización que se pueden crear solo está limitada por la disponibilidad de los recursos del sistema. Este parámetro puede ser NULL si esta información no es necesaria.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Windows 10, versión 1709: las canalizaciones solo se admiten en un contenedor de aplicaciones; es decir, desde un proceso de UWP a otro proceso de UWP que forma parte de la misma aplicación. Además, las canalizaciones con nombre deben usar la sintaxis "\\.\pipe\LOCAL\" para el nombre de la canalización.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows 2000 Server [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado namedpipeapi.h
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

CreateNamedPipe

GetNamedPipeHandleState

Funciones de canalización

Información general sobre canalizaciones