Función SetupComm (winbase.h)

Inicializa los parámetros de comunicación para un dispositivo de comunicaciones especificado.

Sintaxis

BOOL SetupComm(
  [in] HANDLE hFile,
  [in] DWORD  dwInQueue,
  [in] DWORD  dwOutQueue
);

Parámetros

[in] hFile

Identificador del dispositivo de comunicaciones. La función CreateFile devuelve este identificador.

[in] dwInQueue

Tamaño recomendado del búfer de entrada interno del dispositivo, en bytes.

[in] dwOutQueue

Tamaño recomendado del búfer de salida interno del dispositivo, en bytes.

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

Después de que un proceso use la función CreateFile para abrir un identificador en un dispositivo de comunicaciones, pero antes de realizar cualquier E/S con el dispositivo, puede llamar a SetupComm para establecer los parámetros de comunicación para el dispositivo. Si no los establece, el dispositivo usa los parámetros predeterminados cuando se produce la primera llamada a otra función de comunicaciones.

Los parámetros dwInQueue y dwOutQueue especifican los tamaños recomendados para los búferes internos usados por el controlador para el dispositivo especificado. Por ejemplo, los paquetes de protocolo YMODEM son ligeramente mayores que 1024 bytes. Por lo tanto, un tamaño de búfer recomendado puede ser de 1200 bytes para las comunicaciones YMODEM. En el caso de las comunicaciones basadas en Ethernet, un tamaño de búfer recomendado puede ser de 1600 bytes, que es ligeramente mayor que un único marco Ethernet.

El controlador de dispositivo recibe los tamaños de búfer recomendados, pero es libre de usar cualquier esquema de almacenamiento en búfer de entrada y salida (E/S), siempre y cuando proporcione un rendimiento razonable y los datos no se pierdan debido a la saturación (excepto en circunstancias extremas). Por ejemplo, la función puede realizarse correctamente aunque el controlador no asigne un búfer, siempre y cuando alguna otra parte del sistema proporcione una funcionalidad equivalente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	winbase.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll

Vea también

Funciones de comunicaciones

Recursos de comunicaciones

CreateFile

SetCommState