Функция PurgeComm

Функция PurgeComm сбрасывает все символы из буфера вывода или ввода данных указанного коммуникационного ресурса. Она может также завершить работу ожидающих обработки операций чтения или записи на ресурсе.

Синтаксис

BOOL PurgeComm(
  HANDLE hFile,
  DWORD dwFlags
);

Параметры

hFile
[in] Дескриптор коммуникационного ресурса. Функция CreateFile возвращает этот дескриптор.
dwFlags
[in] Этот параметр может состоять из одного или нескольких ниже перечисленных значений.

 

Значение Предназначение
PURGE_TXABORT Завершает работу всех ожидающих обработки асинхронных операций записи и возвращает значение немедленно, даже если операции записи не завершились.
PURGE_RXABORT Завершает работу всех ожидающих обработки асинхронных операций чтения и возвращает значение немедленно, даже если операции чтения не завершились.
PURGE_TXCLEAR Очищает буфер вывода данных (если драйвер устройства тот же самый).
PURGE_RXCLEAR Очищает буфер ввода данных (если драйвер устройства тот же самый).

Возвращаемые значения

Если функция завершается успешно, возвращаемое значение не нуль.

Если функция завершается ошибкой, возвращаемое значение равняется нулю. Чтобы получить дополнительную информацию об ошибке, вызовите GetLastError.

Замечания

Если поток использует PurgeComm, чтобы освободить буфер вывода данных, удаленные символы не передаются. Чтобы опорожнить буфер вывода данных, в то же время гарантируя, что содержание будет передано, вызовите функцию FlushFileBuffers (синхронную операцию). 

Обратите внимание!, однако, на то, что функция FlushFileBuffers подчиняется  управлению потоком данных, но не записывает простои и не возвращает значения до тех пор, пока все ожидающие обработки операции записи не будут переданы.

Смотри также

Обзор Коммуникационные ресурсы, Функции, используемые коммуникационными ресурсами, CreateFile

Размещение и совместимость PurgeComm

К

Windows XP

Да

л

Windows 2000 Professional

Да

и

Windows NT Workstation

Да

е

Windows Me

Да

н

Windows 98

Да

 т

Windows 95

Да

 
С

Windows 2003 Server

Да
е

Windows 2000 Server

Да 
р

Windows NT Server

Да
в

 

 
е

 

 
р 

 

 
 

Используемая библиотека

Kernel32.lib

 

Заголовочный файл

 
 

- объявлено в

Winbase.h

 

- включено в

Windows.h

 

Unicode

-

 

Замечания по платформе

Не имеется

 

Назад в оглавление
На главную страницу
В оглавление справки

Hosted by uCoz