IPrintCoreHelperPS::GetGlobalAttribute-Methode (prcomoem.h)

Artikel
02/29/2024

Die IPrintCoreHelperPS::GetGlobalAttribute-Methode ruft die globale Attributliste oder den Wert eines bestimmten globalen Attributs ab.

Syntax

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

Parameter

[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 globalen Attributnamen an, anstatt einen bestimmten globalen Attributnamen anzugeben.

[out] pdwDataType

Ein Zeiger auf die 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 Aufrufer 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 angibt, auf den der pbData-Parameter verweist.

Rückgabewert

IPrintCoreHelperPS::GetGlobalAttribute 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.
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::GetGlobalAttribute aufgerufen wird, wobei die Parameter pszAttribute und pbData auf NULL festgelegt sind, gibt die Methode zurück, wobei pcbSize auf die Anzahl der Bytes festgelegt ist, die für die Liste aller unterstützten globalen Attributnamen erforderlich sind. Wenn diese Methode ein zweites Mal aufgerufen wird, wobei pszAttribute auf NULL festgelegt ist und pbData auf einen Puffer der Größe zeigt, die 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 globalen Attributnamen verweist. Diese Liste wird mit zwei NULL-Zeichen beendet.