Fungsi GetForm

Fungsi GetForm mengambil informasi tentang formulir tertentu.

Sintaks

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

Parameter

hPrinter [in]

Handel ke pencetak. Gunakan fungsi OpenPrinter atau AddPrinter untuk mengambil handel printer.

pFormName [in]

Penunjuk ke string yang dihentikan null yang menentukan nama formulir. Untuk mendapatkan nama formulir yang didukung oleh printer, panggil fungsi EnumForms .

Level [in]

Versi struktur yang menunjuk pForm . Nilai ini harus 1 atau 2.

pForm [out]

Penunjuk ke array byte yang menerima struktur FORM_INFO_1 atau FORM_INFO_2 yang diinisialisasi.

cbBuf [in]

Ukuran, dalam byte, dari array pForm .

pcbNeeded [out]

Penunjuk ke nilai yang menentukan jumlah byte yang disalin jika fungsi berhasil atau jumlah byte yang diperlukan jika cbBuf terlalu kecil.

Mengembalikan nilai

Jika fungsi berhasil, nilai yang dikembalikan adalah nilai bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol.

Keterangan

Catatan

Ini adalah fungsi pemblokiran atau sinkron dan mungkin tidak segera dikembalikan. Seberapa cepat fungsi ini kembali tergantung pada faktor run-time seperti status jaringan, konfigurasi server cetak, dan faktor implementasi driver printer yang sulit diprediksi saat menulis aplikasi. Memanggil fungsi ini dari utas yang mengelola interaksi dengan antarmuka pengguna dapat membuat aplikasi tampak tidak responsif.

Jika penelepon jarak jauh, dan Tingkatnya adalah 2, nilai StringType dari FORM_INFO_2 yang dikembalikan akan selalu STRING_LANGPAIR.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung
Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung
Windows 2000 Server [hanya aplikasi desktop]
Header
Winspool.h (termasuk Windows.h)
Pustaka
Winspool.lib
DLL
Winspool.drv
Nama Unicode dan ANSI
GetFormW (Unicode) dan GetFormA (ANSI)

Lihat juga

Pencetakan

Cetak Fungsi API Spooler

TambahkanFormulir

DeleteForm

OpenPrinter

SetForm