IPrintCoreUI2::EnumOptions-Methode (prcomoem.h)

Artikel
02/26/2024

Die IPrintCoreUI2::EnumOptions -Methode listet die verfügbaren Optionen eines bestimmten Features auf.

Syntax

HRESULT EnumOptions(
  [in]  POEMUIOBJ poemuiobj,
  [in]  DWORD     dwFlags,
  [in]  PCSTR     pszFeatureKeyword,
  [out] PZZSTR    pmszOptionList,
  [in]  DWORD     cbSize,
  [out] PDWORD    pcbNeeded
);

Parameter

[in] poemuiobj

Zeiger auf den aktuellen Kontext, eine OEMUIOBJ-Struktur .

[in] dwFlags

Ist reserviert und muss auf 0 (null) festgelegt werden.

[in] pszFeatureKeyword

Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine ASCII-Zeichenfolge enthält, die ein Feature angibt, Schlüsselwort (keyword) dessen Optionen angefordert werden.

[out] pmszOptionList

Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine durch NULL getrennte Liste in MULTI_SZ Format empfängt, die die Optionsschlüsselwörter für das Feature enthält, auf die von pszFeatureKeyword verwiesen Schlüsselwort (keyword). Diese Liste wird mit zwei NULL-Zeichen beendet.

Legen Sie diesen Parameter auf NULL fest, um einfach die Größe (*pcbNeeded) der Optionsliste abzufragen, ohne dass die Liste ausgefüllt wird.

[in] cbSize

Gibt die Größe des Puffers in Bytes an, auf den pmszOptionList verweist.

[out] pcbNeeded

Zeiger auf einen Speicherort im Arbeitsspeicher, der die tatsächliche Größe der Optionsliste in Bytes empfängt.

Rückgabewert

Diese Methode muss einen der folgenden Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode wurde erfolgreich ausgeführt.
E_OUTOFMEMORY	Der Wert in cbSize war kleiner als die Anzahl der Bytes, die in den Ausgabepuffer geschrieben werden sollen (der Puffer, auf den pmszOptionList verweist). Die -Methode wurde aufgerufen, wobei pmszOptionList auf NULL festgelegt ist.
E_INVALIDARG	Die Zeichenfolge, auf die von pszFeatureKeyword verwiesen wird, ist kein erkanntes Feature. Der poemuiobj-Parameter verweist auf ein ungültiges Kontextobjekt.
E_NOTIMPL	(Nur Pscript) Das Pscript5-Treiberfeature wird unter der aktuellen Konfiguration nicht unterstützt. Das Pscript5-Treiberfeature wird unter der aktuellen Konfiguration unterstützt, aber die Optionen des Pscript5-Treiberfeatures sind nicht aufzählbar.
E_FAIL	Fehler bei der Methode

Hinweise

Diese Methode wird nur für Windows XP Pscript5-Plug-Ins und nicht für Unidrv-Plug-Ins unterstützt.

Um die Notwendigkeit von zwei Aufrufen pro Datenzugriff zu reduzieren, übergeben Sie der Methode einen Ausgabepuffer einer festen Größe (z. B. 1 KB), und überprüfen Sie dann den Funktionsrückgabewert. Wenn die Methode S_OK zurückgibt, enthält der Puffer bereits die relevanten Daten. Wenn die Methode E_OUTOFMEMORY zurückgibt, ist der Wert in *pcbNeeded die Puffergröße, die zum Speichern der relevanten Daten erforderlich ist. Der Aufrufer sollte dann einen Puffer dieser größeren Größe zuordnen und mit einem zweiten Aufruf der -Methode fortfahren.

Weitere Informationen finden Sie unter Verwenden von EnumOptions.