IPrintCoreUI2::EnumOptions-Methode (prcomoem.h)

Artikel
02/07/2025

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

Zeigen Sie auf den aktuellen Kontext, eine OEMUIOBJ--Struktur.

[in] dwFlags

Ist reserviert und muss auf Null festgelegt werden.

[in] pszFeatureKeyword

Zeigen Sie auf einen vom Aufrufer bereitgestellten Puffer, der eine ASCII-Zeichenfolge enthält, die ein Featureschlüsselwort angibt, dessen Optionen angefordert werden.

[out] pmszOptionList

Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine durch NULL getrennte Liste empfängt, im MULTI_SZ Format, die die Optionsstichwörter für das Feature-Schlüsselwort enthält, auf das durch pszFeatureKeywordverwiesen wird. Diese Liste wird mit zwei Nullzeichen beendet.

Legen Sie diesen Parameter auf NULL- fest, um einfach die Größe (*pcbNeededed) der Optionsliste abzufragen, ohne die Liste ausgefüllt zu haben.

[in] cbSize

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

[out] pcbNeeded

Zeigen Sie auf einen Speicherspeicherort, der die tatsächliche Größe in Byte der Optionsliste empfängt.

Rückgabewert

Diese Methode muss einen der folgenden Werte zurückgeben.

Rückgabecode	Beschreibung
S_OK	Die Methode war erfolgreich.
E_OUTOFMEMORY	Der Wert in cbSize war kleiner als die Anzahl der Bytes, die in den Ausgabepuffer geschrieben werden sollen (der Puffer, auf den pmszOptionListverweist). Die Methode wurde mit pmszOptionList aufgerufen, auf NULL-festgelegt wurde.
E_INVALIDARG	Die Zeichenfolge, auf die pszFeatureKeyword verweist, ist kein erkanntes Feature. Der poemuiobj Parameter, der auf ein ungültiges Kontextobjekt verweist.
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 können nicht aufgezählt werden.
E_FAIL	Fehler bei der Methode.

Bemerkungen

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

Um die Notwendigkeit zu verringern, zwei Aufrufe pro Datenzugriff vorzunehmen, übergeben Sie die Methode an einen Ausgabepuffer mit fester Größe (z. B. 1 KB), und überprüfen Sie dann den Funktionsrücklaufwert. Wenn die Methode S_OK zurückgibt, enthält der Puffer bereits die daten von Interesse. Wenn die Methode E_OUTOFMEMORY zurückgibt, ist der Wert in *pcbNeededed die Puffergröße, die für die Daten von Interesse erforderlich ist. Der Aufrufer sollte dann einen Puffer dieser größeren Größe zuweisen und mit einem zweiten Aufruf der Methode fortfahren.

Weitere Informationen finden Sie unter Using EnumOptions.