IPrintCoreHelperPS::EnumConstrainedOptions-Methode (prcomoem.h)

  • Artikel

Die IPrintCoreHelperPS::EnumConstrainedOptions-Methode stellt basierend auf den aktuellen Einstellungen eine Liste aller Optionen bereit, die in einem bestimmten Feature eingeschränkt sind.

Syntax

HRESULT EnumConstrainedOptions(
  [in, optional] IN const DEVMODE *pDevmode,
  [in]           IN DWORD         cbSize,
  [in]           IN PCSTR         pszFeatureKeyword,
  [out]          OUT PCSTR * []   pConstrainedOptionList,
  [out]          OUT DWORD        *pdwNumOptions
);

Parameter

[in, optional] pDevmode

Ein Zeiger auf eine DEVMODEW-Struktur . Wenn dieser Zeiger bereitgestellt wird, sollte IPrintCoreHelperPS::EnumConstrainedOptions 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] pszFeatureKeyword

Eine Zeichenfolge mit ANSI-Zeichen, die den Featurenamen enthält.

[out] pConstrainedOptionList

Ein Zeiger auf ein Array von ANSI-Zeichenfolgen. Wenn IPrintCoreHelperPS::EnumConstrainedOptions zurückgibt, enthalten diese Zeichenfolgen die Namen aller Optionen, die innerhalb des angegebenen Features eingeschränkt sind. Der Aufrufer ist nicht dafür verantwortlich, das Array oder die einzelnen Zeichenfolgen im Array frei zu geben.

[out] pdwNumOptions

Ein Zeiger auf eine Variable, die die Anzahl der eingeschränkten Optionen im Array empfängt, auf die vom Parameter pConstrainedOptionList verwiesen wird.

Rückgabewert

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

Rückgabecode BESCHREIBUNG
S_OK Die eingeschränkten Optionen wurden für das angegebene Feature festgelegt.
E_FAIL Der Aufrufer hat Informationen bereitgestellt, die zu einer ungültigen Anforderung geführt haben, z. B. eine Anforderung für ein Feature, das nicht vorhanden ist.
E_INVALIDARG Mindestens eines der Argumente war ungültig. Dieser Wert kann bedeuten, dass das Feature nicht unterstützt wird.
E_OUTOFMEMORY Es war nicht genügend Arbeitsspeicher vorhanden, um das Optionsarray zu erstellen, oder der Kerntreiber konnte die Anforderung aufgrund fehlenden Arbeitsspeichers nicht verarbeiten.
E_UNEXPECTED oder andere Fehler, die hier nicht aufgeführt sind Unerwartete Fehlerbedingung. Der Kerntreiber befindet sich wahrscheinlich in einem ungültigen Zustand. Der Aufrufer sollte mit einem Fehlercode beendet werden.

Anforderungen

Anforderung Wert
Zielplattform Desktop
Kopfzeile prcomoem.h (include Prcomoem.h)

Weitere Informationen

IPrintCoreHelperPS

IPrintCoreHelperPS::EnumOptions