Metode IPrintCoreHelperPS::GetOptionAttribute (prcomoem.h)

Artikel
08/07/2023

Metode IPrintCoreHelperPS::GetOptionAttribute mengambil daftar atribut opsi atau nilai atribut opsi tertentu.

Sintaks

HRESULT GetOptionAttribute(
  [in]  PCSTR  pszFeatureKeyword,
  [in]  PCSTR  pszOptionKeyword,
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

Parameter

[in] pszFeatureKeyword

Penunjuk ke buffer yang disediakan penelepon yang berisi string ANSI yang menentukan kata kunci fitur yang akan dikueri.

[in] pszOptionKeyword

Penunjuk ke buffer yang disediakan penelepon yang berisi string ANSI yang menentukan kata kunci opsi untuk dikueri. Nilai ini dapat diperoleh dari panggilan sebelumnya ke IPrintCoreHelperPS::EnumOptions.

[in] pszAttribute

Penunjuk ke buffer yang disediakan penelepon yang berisi string ANSI yang menentukan atribut yang diminta. Jika parameter ini NULL, pemanggil meminta daftar semua nama atribut yang didukung untuk opsi alih-alih menentukan nama atribut tertentu untuk opsi tersebut.

[out] pdwDataType

Penunjuk ke variabel yang menerima nilai yang menentukan jenis data atribut yang diminta. Nilai ini adalah enumerator dari jenis enumerasi EATTRIBUTE_DATATYPE , yang didefinisikan dalam printoem.h.

[out] ppbData

Penunjuk ke buffer yang dialokasikan penerima panggilan yang berisi data yang diminta. Setelah menyelesaikan metode ini, pemanggil tidak perlu merilis buffer ini.

[out] pcbSize

Penunjuk ke variabel yang menerima ukuran, dalam byte, dari buffer yang diacu oleh parameter pbData .

Nilai kembali

IPrintCoreHelperPS::GetOptionAttribute harus mengembalikan salah satu nilai berikut.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil.
E_FAIL	Metode gagal.
E_INVALIDARG	Metode ini mencoba mengkueri atribut yang tidak ada. Nilai ini mungkin juga berarti bahwa nama kata kunci fitur atau nama kata kunci opsi tidak dikenali.
E_OUTOFMEMORY	Nilai dalam pcbSize lebih kecil dari jumlah byte yang akan ditulis ke buffer output yang diacu oleh pbData.

Keterangan

Jika parameter IPrintCoreHelperPS::GetOptionAttributedipanggil dengan parameter pszAttribute dan pbData yang diatur ke NULL, metode mengembalikan dengan pcbSize yang diatur ke jumlah byte yang diperlukan untuk daftar semua nama atribut yang didukung untuk opsi tersebut. Jika metode ini disebut untuk kedua kalinya, dengan pszAttribute diatur ke NULL dan pbData menunjuk ke buffer ukuran yang ditentukan dalam pcbSize dalam panggilan sebelumnya, metode mengembalikan dengan pdwDataType diatur ke kADT_ASCII (enumerator dari jenis enumerasi EATTRIBUTE_DATATYPE ) dan pbData menunjuk ke daftar yang dibatasi NULL dari semua nama atribut yang didukung untuk opsi tersebut. Daftar ini dihentikan dengan dua karakter null.