Fungsi SetupComm (winbase.h)

Menginisialisasi parameter komunikasi untuk perangkat komunikasi tertentu.

Sintaks

BOOL SetupComm(
  [in] HANDLE hFile,
  [in] DWORD  dwInQueue,
  [in] DWORD  dwOutQueue
);

Parameter

[in] hFile

Handel ke perangkat komunikasi. Fungsi CreateFile mengembalikan handel ini.

[in] dwInQueue

Ukuran buffer input internal perangkat yang direkomendasikan, dalam byte.

[in] dwOutQueue

Ukuran buffer output internal perangkat yang direkomendasikan, dalam byte.

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

Setelah proses menggunakan fungsi CreateFile untuk membuka handel ke perangkat komunikasi, tetapi sebelum melakukan I/O apa pun dengan perangkat, ia dapat memanggil SetupComm untuk mengatur parameter komunikasi untuk perangkat. Jika tidak mengaturnya, perangkat menggunakan parameter default saat panggilan pertama ke fungsi komunikasi lain terjadi.

Parameter dwInQueue dan dwOutQueue menentukan ukuran yang direkomendasikan untuk buffer internal yang digunakan oleh driver untuk perangkat yang ditentukan. Misalnya, paket protokol YMODEM sedikit lebih besar dari 1024 byte. Oleh karena itu, ukuran buffer yang direkomendasikan mungkin 1200 byte untuk komunikasi YMODEM. Untuk komunikasi berbasis Ethernet, ukuran buffer yang direkomendasikan mungkin 1600 byte, yang sedikit lebih besar dari satu bingkai Ethernet.

Driver perangkat menerima ukuran buffer yang direkomendasikan, tetapi bebas untuk menggunakan skema buffering input dan output (I/O), selama memberikan performa dan data yang wajar tidak hilang karena diserbu (kecuali dalam keadaan ekstrem). Misalnya, fungsi dapat berhasil meskipun driver tidak mengalokasikan buffer, selama beberapa bagian lain dari sistem menyediakan fungsionalitas yang setara.

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

Lihat juga

Fungsi Komunikasi

Sumber Daya Komunikasi

CreateFile

SetCommState