IPrintCoreHelper::EnumConstrainedOptions-Methode (prcomoem.h)
Die IPrintCoreHelper::EnumConstrainedOptions--Methode stellt eine Liste aller Optionen bereit, die in einem bestimmten Feature eingeschränkt sind, basierend auf aktuellen Einstellungen.
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, sollten IPrintCoreHelper::EnumConstrainedOptions- 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 IPrintOemPS::D evMode oder IPrintOemUni::D evMode oder von einem Druckticketanbieter 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 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] pszFeatureKeyword
Eine Zeichenfolge von ANSI-Zeichen, die den Featurenamen enthalten.
[out] pConstrainedOptionList
Ein Zeiger auf ein Array von ANSI-Zeichenfolgen. Wenn IPrintCoreHelper::EnumConstrainedOptions zurückgegeben wird, enthalten diese Zeichenfolgen die Namen aller Optionen, die innerhalb des angegebenen Features eingeschränkt sind. Der Aufrufer ist nicht für das Freigeben des Arrays oder der einzelnen Zeichenfolgen im Array verantwortlich.
[out] pdwNumOptions
Ein Zeiger auf eine Variable, die die Anzahl der eingeschränkten Optionen im Array empfängt, auf die durch den pConstrainedOptionList-Parameter verwiesen wird.
Rückgabewert
IPrintCoreHelper::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 ein Argument 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 des fehlenden Arbeitsspeichers nicht bedienen. |
| E_UNEXPECTED oder andere Fehler, die hier nicht explizit aufgeführt sind, | Unerwarteter Zustand. Der Kerntreiber befindet sich wahrscheinlich in einem ungültigen Zustand. Der Aufrufer sollte mit einem Fehlercode beendet werden. |
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform- | Desktop |
| Header- | prcomoem.h (einschließlich Prcomoem.h) |