Metodo IPrintCoreHelperPS::GetGlobalAttribute (prcomoem.h)

2025-02-07

Il metodo IPrintCoreHelperPS::GetGlobalAttribute recupera l'elenco di attributi globali o il valore di un attributo globale specifico.

Sintassi

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

Parametri

[in] pszAttribute

Puntatore a un buffer fornito dal chiamante che contiene una stringa ANSI che specifica l'attributo richiesto. Se questo parametro è NULL, il chiamante richiede un elenco di tutti i nomi di attributi globali supportati anziché specificare un nome di attributo globale specifico.

[out] pdwDataType

Puntatore a variabile che riceve un valore che specifica il tipo di dati dell'attributo richiesto. Questo valore è un enumeratore del tipo di enumerazione EATTRIBUTE_DATATYPE, definito in printoem.h.

[out] ppbData

Puntatore a un buffer allocato chiamato contenente i dati richiesti. Al termine di questo metodo, il chiamante non deve rilasciare questo buffer.

[out] pcbSize

Puntatore a una variabile che specifica le dimensioni, in byte, del buffer a cui punta il parametro pbData.

Valore restituito

IPrintCoreHelperPS::GetGlobalAttribute deve restituire uno dei valori seguenti.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
E_FAIL	Il metodo non è riuscito.
E_INVALIDARG	Il metodo ha tentato di eseguire una query per un attributo inesistente.
E_OUTOFMEMORY	Il valore in pcbSize è minore del numero di byte da scrivere nel buffer di output a cui punta pbData.

Osservazioni

Se IPrintCoreHelperPS::GetGlobalAttribute viene chiamato con i relativi pszAttribute e parametri pbData impostati su NULL, il metodo restituisce con pcbSize impostato sul numero di byte necessari per l'elenco di tutti i nomi di attributi globali supportati. Se questo metodo viene chiamato una seconda volta, con pszAttribute impostato su NULL e pbData che punta a un buffer delle dimensioni specificate in pcbSize nella chiamata precedente, il metodo restituisce con pdwDataType impostato su kADT_ASCII (un enumeratore del tipo di enumerazione EATTRIBUTE_DATATYPE) e pbData che punta a un elenco delimitato da NULL di tutti i tipi globali supportati nomi di attributi. Questo elenco viene terminato con due caratteri Null.