Función PurgeComm (winbase.h)

  • Artículo

Descarta todos los caracteres del búfer de entrada o salida de un recurso de comunicaciones especificado. También puede finalizar las operaciones de lectura o escritura pendientes en el recurso.

Sintaxis

BOOL PurgeComm(
  [in] HANDLE hFile,
  [in] DWORD  dwFlags
);

Parámetros

[in] hFile

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

[in] dwFlags

Este parámetro puede ser uno o más de los siguientes valores.

Valor Significado
PURGE_RXABORT
0x0002
 Finaliza todas las operaciones de lectura superpuestas pendientes y devuelve inmediatamente, incluso si no se han completado las operaciones de lectura.
PURGE_RXCLEAR
0x0008
 Borra el búfer de entrada (si el controlador del dispositivo tiene uno).
PURGE_TXABORT
0x0001
 Finaliza todas las operaciones de escritura superpuestas pendientes y devuelve inmediatamente, incluso si no se han completado las operaciones de escritura.
PURGE_TXCLEAR
0x0004
 Borra el búfer de salida (si el controlador del dispositivo tiene uno).

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

Si un subproceso usa PurgeComm para vaciar un búfer de salida, los caracteres eliminados no se transmiten. Para vaciar el búfer de salida al asegurarse de que se transmite el contenido, llame a la función FlushFileBuffers (una operación sincrónica). Sin embargo, tenga en cuenta que FlushFileBuffers está sujeto al control de flujo, pero no a los tiempos de espera de escritura, y no devolverá hasta que se hayan transmitido todas las operaciones de escritura pendientes.

Requisitos

   
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 (incluye Windows.h)
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

Funciones de comunicaciones

Recursos de comunicaciones

CreateFile