IPrintCoreHelperUni::Metode GetOption (prcomoem.h)

  • Artikel

Metode IPrintCoreHelperUni::GetOption ini mendapatkan opsi yang ditentukan untuk fitur tertentu.

Sintaks

HRESULT GetOption(
  [in, optional] const DEVMODE *pDevmode,
  [in]           DWORD         cbSize,
  [in]           PCSTR         pszFeatureRequested,
  [out]          PCSTR         *ppszOption
);

Parameter

[in, optional] pDevmode

Penunjuk ke struktur DEVMODEW . Jika pointer ini disediakan, IPrintCoreHelperUni::GetOption harus menggunakan struktur DEVMODEW yang diarahkan oleh pDevmode alih-alih struktur DEVMODEW default atau saat ini. Jika metode ini dipanggil dari penyedia plug-in atau dari IPrintOemUni::D evMode, parameter ini diperlukan. Dalam sebagian besar situasi lainnya, parameter harus NULL. Ketika driver inti mengatur pDevmode ke NULL, ia memodifikasi status internalnya daripada struktur DEVMODEW yang diteruskan. Ini diperlukan selama operasi seperti penggantian UI penuh, di mana struktur DEVMODEW yang dikembalikan oleh DDI, seperti DrvDocumentPropertySheets, sedang dilayankan oleh modul UI driver inti.

[in] cbSize

Ukuran, dalam byte, dari struktur DEVMODEW yang diarahkan oleh parameter pDevmode .

[in] pszFeatureRequested

Penunjuk ke string ANSI yang berisi nama fitur seperti yang muncul dalam file GPD.

[out] ppszOption

Penunjuk ke variabel yang berisi alamat string ANSI. Saat IPrintCoreHelperUni::GetOption kembali, string harus berisi kata kunci untuk opsi yang saat ini dipilih seperti yang muncul dalam file konfigurasi. Pemanggil tidak boleh mengubah string ini dan tidak boleh membebaskan memori yang terkait dengan string ini.

Nilai kembali

IPrintCoreHelperUni::GetOption harus mengembalikan salah satu nilai berikut.

Menampilkan kode Deskripsi
S_OK
 Metode membaca opsi untuk fitur yang ditentukan.
E_FAIL
 Pemanggil memberikan informasi yang mengakibatkan permintaan tidak valid. Misalnya, fitur yang diminta tidak ada.
E_INVALIDARG
 Argumen tidak valid. Nilai ini mungkin berarti bahwa fitur tidak didukung atau terlalu banyak opsi yang diminta untuk fitur tersebut.
E_OUTOFMEMORY
 Driver inti tidak dapat melayani permintaan karena memori tidak cukup.
E_UNEXPECTED, atau kode pengembalian lainnya yang tidak tercantum di sini
 Driver inti tampaknya dalam keadaan tidak valid. Pemanggil harus mengembalikan kode kegagalan.

Keterangan

IPrintCoreHelperUni::GetOption tidak dapat digunakan untuk fitur yang memungkinkan beberapa opsi diatur secara bersamaan.

Kata kunci fitur seperti yang didefinisikan dalam file GPD. Selain itu, driver Unidrv mendukung beberapa kata kunci yang dipesan untuk opsi yang disimpan dalam struktur DEVMODEW privatnya. Untuk daftar fitur Unidrv, lihat Pemetaan Kata Kunci.

Pemanggil tidak boleh membebaskan string yang ditujukkan oleh ppszOption dan tidak boleh memodifikasi string dengan cara apa pun.

Persyaratan

Persyaratan Nilai
Target Platform Desktop
Header prcomoem.h (termasuk Prcomoem.h)

Lihat juga

IPrintCoreHelperUni

IPrintCoreHelperUni::SetOptions