IPrintCoreHelperPS::GetOptionAttribute-Methode (prcomoem.h)

Artikel
02/29/2024

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 Feature angibt, für das Schlüsselwort (keyword) abfragen werden soll.

[in] pszOptionKeyword

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine ANSI-Zeichenfolge enthält, die die Option angibt, nach Schlüsselwort (keyword) abfragen werden soll. Dieser Wert kann aus einem vorherigen Aufruf von IPrintCoreHelperPS::EnumOptions abgerufen 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 aufgerufenen zugeordneten 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 Bytes empfängt, auf die vom pbData-Parameter verwiesen wird.

Rückgabewert

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

Rückgabecode	BESCHREIBUNG
S_OK	Die Methode wurde erfolgreich ausgeführt.
E_FAIL	Fehler bei der Methode.
E_INVALIDARG	Die Methode hat versucht, ein nicht vorhandenes Attribut abzufragen. Dieser Wert kann auch bedeuten, dass das Feature Schlüsselwort (keyword) Namen oder option Schlüsselwort (keyword) Namen 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.

Hinweise

Wenn IPrintCoreHelperPS::GetOptionAttributeaufgerufen wird, wobei die Parameter pszAttribute und pbData auf NULL festgelegt sind, gibt die Methode mit festgelegtem pcbSize auf die Anzahl der Bytes zurück, die für die Liste aller unterstützten Attributnamen für die Option benötigt werden. Wenn diese Methode ein zweites Mal aufgerufen wird, wobei pszAttribute auf NULL festgelegt ist und pbData auf einen Puffer der Größe verweist, der im vorherigen Aufruf in pcbSize angegeben wurde, gibt die Methode zurück, wobei pdwDataType auf kADT_ASCII festgelegt ist (ein Enumerator des EATTRIBUTE_DATATYPE Enumerationstyps) und pbData , der auf eine durch NULL getrennte Liste aller unterstützten Attributnamen für die Option verweist. Diese Liste wird mit zwei NULL-Zeichen beendet.