Fungsi EngGetForm (winddi.h)

Fungsi EngGetForm mendapatkan detail FORM_INFO_1 untuk formulir yang ditentukan.

Sintaks

ENGAPI BOOL EngGetForm(
  [in]           HANDLE  hPrinter,
  [in]           LPWSTR  pFormName,
  [in]           DWORD   Level,
  [in, optional] LPBYTE  pForm,
  [in]           DWORD   cbBuf,
  [out]          LPDWORD pcbNeeded
);

Parameter

[in] hPrinter

Tangani ke pencetak yang formulirnya sedang ditentukan.

[in] pFormName

Penunjuk ke string yang menentukan nama formulir.

[in] Level

Menentukan versi struktur formulir yang menunjuk pForm . Nilai ini harus 1, yang menunjukkan bahwa informasi formulir akan dikembalikan dalam struktur FORM_INFO_1.

[in, optional] pForm

Penunjuk ke array byte yang menerima struktur FORM_INFO_1 yang diinisialisasi.

[in] cbBuf

Menentukan ukuran, dalam byte, dari pForm.

[out] pcbNeeded

Penunjuk ke nilai yang menentukan jumlah byte yang disalin ke dalam buffer yang diacu oleh pForm jika fungsi berhasil. Nilai adalah jumlah byte yang diperlukan untuk melakukan penyalinan jika cbBuf terlalu kecil.

Nilai kembali

EngGetForm mengembalikan TRUE jika struktur formulir berhasil disalin ke dalam pForm. Jika tidak, ia mencatat pesan kesalahan dan mengembalikan FALSE. Untuk mendapatkan informasi kesalahan, hubungi EngGetLastError.

Keterangan

EngGetForm mengembalikan struktur FORM_INFO_1 (dijelaskan dalam dokumentasi Microsoft Windows SDK) yang berisi data formulir yang terkait dengan pFormName. Data tertulis dan ukurannya dikembalikan ke pemanggil melalui pForm dan pcbNeeded, masing-masing. Jika array yang ditunjukkan oleh pForm tidak cukup besar untuk menyimpan data formulir, ukuran array yang diperlukan malah dikembalikan dalam pcbNeeded.

Untuk mendapatkan daftar semua formulir yang didukung, driver printer harus memanggil EngEnumForms.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia di Windows 2000 dan versi yang lebih baru dari sistem operasi Windows.
Target Platform	Universal
Header	winddi.h (termasuk Winddi.h)
Pustaka	Win32k.lib
DLL	Win32k.sys

Lihat juga

EngEnumForms

EngGetLastError