Metodo IPrintCorePS2::GetGlobalAttribute (prcomoem.h)

Articolo
03/14/2023

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

Sintassi

HRESULT GetGlobalAttribute(
  [in]  PDEVOBJ pdevobj,
  [in]  DWORD   dwFlags,
  [in]  PCSTR   pszAttribute,
  [out] PDWORD  pdwDataType,
  [out] PBYTE   pbData,
  [in]  DWORD   cbSize,
  [out] PDWORD  pcbNeeded
);

Parametri

[in] pdevobj

Puntatore a una struttura DEVOBJ .

[in] dwFlags

È riservato e deve essere impostato su zero.

[in] pszAttribute

Puntatore a un buffer fornito dal chiamante contenente una stringa ASCII che specifica l'attributo singolo 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 una posizione di memoria che riceve un valore che specifica il tipo di dati dell'attributo richiesto. Questo valore è un enumeratore dell'enumerazione EATTRIBUTE_DATATYPE , definita in printoem.h.

[out] pbData

Puntatore a un buffer fornito dal chiamante che riceve i dati richiesti. Per eseguire una query semplicemente per il numero di byte necessari per soddisfare una richiesta, impostare questo parametro su NULL.

[in] cbSize

Specifica le dimensioni, in byte del buffer a cui punta pbData.

[out] pcbNeeded

Puntatore a una posizione di memoria che riceve le dimensioni effettive, in byte, dei dati richiesti.

Valore restituito

Questo metodo deve restituire uno dei valori seguenti.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
E_OUTOFMEMORY	Il valore in cbSize è minore del numero di byte da scrivere nel buffer di output (il buffer a cui punta pbData). Il metodo è stato chiamato con pbData impostato su NULL.
E_INVALIDARG	Il metodo ha tentato di eseguire una query per un attributo non esistente. Il parametro pdevobj punta a un oggetto contesto driver non valido.
E_FAIL	Il metodo non è riuscito.

Commenti

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

Per ridurre la necessità di effettuare due chiamate per accesso ai dati, passare il metodo un buffer di output di dimensioni fisse (ad esempio 1 KB) e quindi controllare il valore restituito dalla funzione. Se il metodo restituisce S_OK, il buffer contiene già i dati di interesse. Se il metodo restituisce E_OUTOFMEMORY, il valore in *pcbNeeded è la dimensione del buffer necessaria per contenere i dati di interesse. Il chiamante deve quindi allocare un buffer di dimensioni maggiori e procedere con una seconda chiamata al metodo.

Questo metodo è supportato per qualsiasi plug-in di rendering Pscript5.

Per altre informazioni, vedere Uso di GetGlobalAttribute.