Función SetCommMask (winbase.h)

Artículo
03/03/2024

Especifica un conjunto de eventos que se van a supervisar para un dispositivo de comunicaciones.

Sintaxis

BOOL SetCommMask(
  [in] HANDLE hFile,
  [in] DWORD  dwEvtMask
);

Parámetros

[in] hFile

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

[in] dwEvtMask

Eventos que se van a habilitar. Un valor de cero deshabilita todos los eventos. Este parámetro puede ser uno o más de los siguientes valores.

Valor	Significado
EV_BREAK 0x0040	Se ha detectado una interrupción en la entrada.
EV_CTS 0x0008	El estado de la señal CTS (despejado a envío).
EV_DSR 0x0010	El estado de la señal DSR (listo para conjuntos de datos) ha cambiado.
EV_ERR 0x0080	Error de estado de línea. Los errores de estado de línea son CE_FRAME, CE_OVERRUN y CE_RXPARITY.
EV_RING 0x0100	Se ha detectado un indicador de llamada.
EV_RLSD 0x0020	El estado de la señal RLSD (receive-line-signal-detect).
EV_RXCHAR 0x0001	Se ha recibido y colocado un carácter en el búfer de entrada.
EV_RXFLAG 0x0002	Se recibió el carácter de evento y se colocó en el búfer de entrada. El carácter de evento se especifica en la estructura DCB del dispositivo, que se aplica a un puerto serie mediante la función SetCommState .
EV_TXEMPTY 0x0004	Se envió el último carácter del búfer de salida.

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

La función SetCommMask especifica el conjunto de eventos que se pueden supervisar para un recurso de comunicaciones determinado. Se puede especificar un identificador para el recurso de comunicaciones en una llamada a la función WaitCommEvent , que espera a que se produzca uno de los eventos. Para obtener la máscara de eventos actual de un recurso de comunicaciones, use la función GetCommMask .

Ejemplos

Para obtener un ejemplo, consulte Supervisión de eventos de comunicaciones.

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