IPrintCoreHelperUni::GetOption-Methode (prcomoem.h)

Artikel
02/07/2025

Die IPrintCoreHelperUni::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 IPrintCoreHelperUni::GetOption die DEVMODEW-Struktur verwenden, auf die von pDevmode- anstelle der Standard- oder der aktuellen DEVMODEW-Struktur verwiesen wird. Wenn diese Methode vom Plug-In-Anbieter oder von IPrintOemUni::D evModeaufgerufen 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 und nicht die der übergebenen DEVMODEW-Struktur. Dies ist bei Vorgängen wie dem vollständigen Austausch der Benutzeroberfläche erforderlich, wobei die von einem DDI zurückgegebene DEVMODEW-Struktur, z. B. DrvDocumentPropertySheets, vom Benutzeroberflächenmodul des Kerntreibers gewartet wird.

[in] cbSize

Die Größe der DEVMODEW-Struktur, auf die durch den pDevmode-Parameter verwiesen wird.

[in] pszFeatureRequested

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

[out] ppszOption

Ein Zeiger auf eine Variable, die die Adresse einer ANSI-Zeichenfolge enthält. Wenn IPrintCoreHelperUni::GetOption zurückgegeben wird, sollte die Zeichenfolge das Schlüsselwort 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

IPrintCoreHelperUni::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 bedienen, da nicht genügend Arbeitsspeicher vorhanden war.
E_UNEXPECTED oder andere hier nicht aufgeführte Rückgabecodes	Der Kerntreiber scheint in einem ungültigen Zustand zu sein. Der Aufrufer sollte einen Fehlercode zurückgeben.

Bemerkungen

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

Featurestichwörter sind in der GPD-Datei definiert. Darüber hinaus unterstützt der Unidrv-Treiber mehrere reservierte Schlüsselwörter für Optionen, die in der privaten DEVMODEW--Struktur gespeichert sind. Eine Liste der Unidrv-Features finden Sie unter Keyword Mapping.

Der Aufrufer sollte die Zeichenfolge, auf die von ppszOption verwiesen wird, nicht freigeben und die Zeichenfolge nicht auf irgendeine Weise ändern.

Anforderungen

Anforderung	Wert
Zielplattform-	Desktop
Header-	prcomoem.h (einschließlich Prcomoem.h)

Siehe auch

IPrintCoreHelperUni

IPrintCoreHelperUni::SetOptions

Freigeben über