Fungsi ClearCommError (winbase.h)
Mengambil informasi tentang kesalahan komunikasi dan melaporkan status perangkat komunikasi saat ini. Fungsi ini dipanggil ketika terjadi kesalahan komunikasi, dan menghapus bendera kesalahan perangkat untuk mengaktifkan operasi input dan output (I/O) tambahan.
Sintaks
BOOL ClearCommError(
[in] HANDLE hFile,
[out, optional] LPDWORD lpErrors,
[out, optional] LPCOMSTAT lpStat
);
Parameter
[in] hFile
Handel ke perangkat komunikasi. Fungsi CreateFile mengembalikan handel ini.
[out, optional] lpErrors
Penunjuk ke variabel yang menerima masker yang menunjukkan jenis kesalahan. Parameter ini bisa menjadi satu atau beberapa nilai berikut.
Nilai berikut ini tidak didukung:
[out, optional] lpStat
Penunjuk ke struktur COMSTAT tempat informasi status perangkat dikembalikan. Jika parameter ini NULL, tidak ada informasi status yang dikembalikan.
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 port komunikasi telah disiapkan dengan nilai TRUE untuk anggota fAbortOnError dari struktur DCB penyiapan, perangkat lunak komunikasi akan mengakhiri semua operasi baca dan tulis pada port komunikasi ketika terjadi kesalahan komunikasi. Tidak ada operasi baca atau tulis baru yang akan diterima sampai aplikasi mengakui kesalahan komunikasi dengan memanggil fungsi ClearCommError .
Fungsi ClearCommError mengisi buffer status yang diacu oleh parameter lpStat dengan status perangkat komunikasi saat ini yang ditentukan oleh parameter hFile .
Persyaratan
Persyaratan | Nilai |
---|---|
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 |