Fungsi PurgeComm (winbase.h)

  • Artikel

Membuang semua karakter dari buffer output atau input dari sumber daya komunikasi tertentu. Ini juga dapat mengakhiri operasi baca atau tulis yang tertunda pada sumber daya.

Sintaks

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

Parameter

[in] hFile

Handel ke sumber daya komunikasi. Fungsi CreateFile mengembalikan handel ini.

[in] dwFlags

Parameter ini bisa menjadi satu atau beberapa nilai berikut.

Nilai Makna
PURGE_RXABORT
0x0002
 Mengakhiri semua operasi baca yang tumpang tindih dan segera kembali, bahkan jika operasi baca belum selesai.
PURGE_RXCLEAR
0x0008
 Menghapus buffer input (jika driver perangkat memilikinya).
PURGE_TXABORT
0x0001
 Mengakhiri semua operasi tulis yang tumpang tindih dan segera kembali, bahkan jika operasi tulis belum selesai.
PURGE_TXCLEAR
0x0004
 Menghapus buffer output (jika driver perangkat memilikinya).

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Jika utas menggunakan PurgeComm untuk membersihkan buffer output, karakter yang dihapus tidak akan ditransmisikan. Untuk mengosongkan buffer output sambil memastikan bahwa konten ditransmisikan, panggil fungsi FlushFileBuffers (operasi sinkron). Perhatikan, bagaimanapun, bahwa FlushFileBuffers tunduk pada kontrol aliran tetapi tidak untuk menulis waktu habis, dan itu tidak akan kembali sampai semua operasi tulis yang tertunda telah ditransmisikan.

Persyaratan

   
Klien minimum yang didukung Windows XP [aplikasi desktop | Aplikasi UWP]
Server minimum yang didukung Windows Server 2003 [aplikasi desktop | Aplikasi UWP]
Target Platform Windows
Header winbase.h (termasuk Windows.h)
Pustaka Kernel32.lib
DLL Kernel32.dll

Lihat juga

Fungsi Komunikasi

Sumber Daya Komunikasi

CreateFile