Fungsi WritePort (winsplp.h)

Artikel
08/08/2023

Fungsi pemantau WritePort port menulis data ke port printer.

Sintaks

BOOL WritePort(
  _In_  HANDLE  hPort,
  _In_  LPBYTE  pBuffer,
        DWORD   cbBuf,
  _Out_ LPDWORD pcbWritten
);

Parameter

[in] hPort

Handel port yang disediakan penelepon.

[in] pBuffer

Penunjuk yang disediakan penelepon ke buffer yang berisi data yang akan ditulis ke port.

cbBuf

Ukuran yang disediakan penelepon, dalam byte, dari pBuffer.

[out] pcbWritten

Penunjuk yang disediakan penelepon ke lokasi untuk menerima jumlah byte yang berhasil ditulis ke port.

Nilai kembali

Jika operasi berhasil, fungsi harus mengembalikan TRUE. Jika tidak, maka akan mengembalikan FALSE.

Keterangan

Monitor bahasa dan DLL server monitor port diperlukan untuk menentukan WritePort fungsi dan menyertakan alamat fungsi dalam struktur MONITOR2 .

Handel yang diterima sebagai argumen hPort fungsi adalah handel port yang disediakan fungsi OpenPort atau OpenPortEx monitor.

Biasanya, fungsi monitor WritePort bahasa menambahkan perintah khusus bahasa ke aliran data yang terkandung dalam buffer yang diarahkan oleh pBuffer, lalu meneruskan aliran data yang dimodifikasi ke fungsi monitor WritePort port.

Fungsi DLL WritePort server monitor port biasanya memanggil WriteFile (dijelaskan dalam dokumentasi Microsoft Windows SDK) untuk mengirim aliran data ke driver port mode kernel.

Pekerjaan cetak umum terdiri dari beberapa panggilan ke WritePort. Setiap panggilan dapat memiliki nilai cbBuf yang berbeda.

Fungsi harus mengembalikan jumlah byte yang berhasil ditulis dengan menempatkan angka di lokasi yang diarahkan oleh pcbWritten. Untuk pemantau bahasa, angka ini tidak boleh menyertakan jumlah byte tambahan khusus bahasa yang ditambahkan ke aliran data.

Penampung menentukan keberhasilan atau kegagalan operasi tulis dengan memeriksa WritePortnilai pengembalian, bukan jumlah byte yang dikembalikan. Jadi jumlah byte nol yang dikembalikan tidak mewakili penulisan yang gagal kecuali fungsi mengembalikan FALSE.

Semacam mekanisme waktu habis yang diimplementasikan sistem atau yang diimplementasikan pemantauan harus memastikan bahwa WritePort fungsi akan kembali dalam jumlah waktu yang wajar, untuk menghindari mengulur-ulur penampung.

Dapat diterima bagi pemantau bahasa untuk memanggil rutinitas monitor WritePort port di luar pasangan StartDocPort/EndDocPort . Namun, beberapa monitor port mungkin gagal dalam panggilan seperti itu, sehingga pemantau bahasa harus ditulis untuk menangani kegagalan ini.