IPrintCoreHelperPS::GetOptionAttribute-Methode (prcomoem.h)

Artikel
02/07/2025

Die IPrintCoreHelperPS::GetOptionAttribute Methode ruft die Optionsattributliste oder den Wert eines bestimmten Optionsattributs ab.

Syntax

HRESULT GetOptionAttribute(
  [in]  PCSTR  pszFeatureKeyword,
  [in]  PCSTR  pszOptionKeyword,
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

Parameter

[in] pszFeatureKeyword

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine ANSI-Zeichenfolge enthält, die das zu abfragende Featureschlüsselwort angibt.

[in] pszOptionKeyword

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine ANSI-Zeichenfolge enthält, die das zu abfragende Optionswort angibt. Dieser Wert kann aus einem vorherigen Aufruf von IPrintCoreHelperPS::EnumOptionsabgerufen werden.

[in] pszAttribute

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine ANSI-Zeichenfolge enthält, die das angeforderte Attribut angibt. Wenn dieser Parameter NULL-ist, fordert der Aufrufer eine Liste aller unterstützten Attributnamen für die Option an, anstatt einen bestimmten Attributnamen für die Option anzugeben.

[out] pdwDataType

Ein Zeiger auf eine Variable, die einen Wert empfängt, der den Datentyp des angeforderten Attributs angibt. Dieser Wert ist ein Enumerator des EATTRIBUTE_DATATYPE Enumerationstyps, der in printoem.h definiert ist.

[out] ppbData

Ein Zeiger auf einen vom Angerufenen zugewiesenen Puffer, der die angeforderten Daten enthält. Nach Abschluss dieser Methode muss der Aufrufer diesen Puffer nicht freigeben.

[out] pcbSize

Ein Zeiger auf eine Variable, die die Größe des Puffers in Byte empfängt, auf den der pbData-Parameter verweist.

Rückgabewert

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

Rückgabecode	Beschreibung
S_OK	Die Methode war erfolgreich.
E_FAIL	Fehler bei der Methode.
E_INVALIDARG	Die Methode hat versucht, ein nicht vorhandenes Attribut abzufragen. Dieser Wert kann auch bedeuten, dass der Schlüsselwort- oder Optionswortname des Features nicht erkannt wurde.
E_OUTOFMEMORY	Der Wert in pcbSize war kleiner als die Anzahl der Bytes, die in den Ausgabepuffer geschrieben werden sollen, auf den pbData-verweist.

Bemerkungen

Wenn IPrintCoreHelperPS::GetOptionAttributemit der pszAttribute- und pbData- Parametern aufgerufen wird, die auf NULL-festgelegt sind, gibt die Methode mit pcbSize auf die Anzahl der Bytes zurück, die für die Liste aller unterstützten Attributnamen für die Option erforderlich sind. Wenn diese Methode ein zweites Mal aufgerufen wird, wobei pszAttribute auf NULL- festgelegt und pbData auf einen Puffer der Größe zeigt, die in pcbSize im vorherigen Aufruf angegeben wurde, die Methode gibt mit pdwDataType- auf kADT_ASCII (ein Aufzählungszeichen des EATTRIBUTE_DATATYPE Enumerationstyps) und pbData-, die auf eine DURCH NULL getrennte Liste aller unterstützten Attribute verweisen, zurück. Namen für die Option. Diese Liste wird mit zwei Nullzeichen beendet.