IPrintCoreHelperPS::GetOption-Methode (prcomoem.h)

Artikel
08/07/2023

Die IPrintCoreHelperPS::GetOption-Methode ruft eine angegebene Option für ein bestimmtes Feature ab.

Syntax

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

Parameter

[in, optional] pDevmode

Ein Zeiger auf eine DEVMODEW-Struktur. Wenn dieser Zeiger bereitgestellt wird, sollte IPrintCoreHelperPS::GetOption anstelle der standardmäßigen oder aktuellen DEVMODEW-Struktur die DEVMODEW-Struktur verwenden, auf die von pDevmode verwiesen wird. Wenn diese Methode vom Plug-In-Anbieter oder von IPrintOemPS::D evMode aufgerufen wird, ist dieser Parameter erforderlich. In den meisten anderen Situationen sollte der Parameter NULL sein. Wenn der Kerntreiber pDevmode auf NULL festlegt, ändert er seinen internen Zustand anstelle der übergebenen DEVMODEW-Struktur. Dies ist bei Vorgängen wie der vollständigen Ersetzung der Benutzeroberfläche erforderlich, bei denen die von einem DDI zurückgegebene DEVMODEW-Struktur, z. B. DrvDocumentPropertySheets, vom Benutzeroberflächenmodul des Haupttreibers verarbeitet wird.

[in] cbSize

Die Größe der DEVMODEW-Struktur in Bytes, auf die der pDevmode-Parameter verweist.

[in] pszFeatureRequested

Ein Zeiger auf die ANSI-Zeichenfolge, die den Namen des Features enthält, wie er in der PPD-Datei angezeigt wird.

[out] ppszOption

Ein Zeiger auf eine Variable, die die Adresse einer ANSI-Zeichenfolge enthält. Wenn IPrintCoreHelperPS::GetOption zurückgibt, sollte die Zeichenfolge die Schlüsselwort (keyword) für die aktuell ausgewählte Option enthalten, wie sie in der Konfigurationsdatei angezeigt wird. Der Aufrufer sollte diese Zeichenfolge nicht ändern und den speicher, der dieser Zeichenfolge zugeordnet ist, nicht freigeben.

Rückgabewert

IPrintCoreHelperPS::GetOption sollte einen der folgenden Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Die -Methode liest die Option für das angegebene Feature.
E_FAIL	Der Aufrufer hat Informationen bereitgestellt, die zu einer ungültigen Anforderung geführt haben. Beispielsweise ist das angeforderte Feature nicht vorhanden.
E_INVALIDARG	Die Argumente waren ungültig. Dieser Wert kann bedeuten, dass das Feature nicht unterstützt wird oder dass zu viele Optionen für das Feature angefordert wurden.
E_OUTOFMEMORY	Der Kerntreiber konnte die Anforderung nicht verarbeiten, da nicht genügend Arbeitsspeicher vorhanden war.
E_UNEXPECTED oder andere Rückgabecodes, die hier nicht aufgeführt sind	Der Kerntreiber scheint sich in einem ungültigen Zustand zu befinden. Der Aufrufer sollte einen Fehlercode zurückgeben.

Hinweise

IPrintCoreHelperPS::GetOption kann nicht für Features verwendet werden, mit denen mehrere Optionen gleichzeitig festgelegt werden können.

Featureschlüsselwörter sind wie in der PPD-Datei definiert. Darüber hinaus unterstützt der Pscript5-Treiber mehrere reservierte Schlüsselwörter für Optionen, die in seiner privaten DEVMODEW-Strukturgespeichert sind. Eine Liste der Pscript5-Features finden Sie unter Schlüsselwortzuordnung.

Der Aufrufer sollte die Zeichenfolge, auf die ppszOption verweist, nicht freigeben und die Zeichenfolge in keiner Weise ändern.