IPrintCoreHelperPS ::GetGlobalAttribute, méthode (prcomoem.h)

Article
02/26/2024

La méthode IPrintCoreHelperPS ::GetGlobalAttribute récupère la liste d’attributs globaux ou la valeur d’un attribut global spécifique.

Syntaxe

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

Paramètres

[in] pszAttribute

Pointeur vers une mémoire tampon fournie par l’appelant qui contient une chaîne ANSI qui spécifie l’attribut demandé. Si ce paramètre a la valeur NULL, l’appelant demande une liste de tous les noms d’attributs globaux pris en charge au lieu de spécifier un nom d’attribut global spécifique.

[out] pdwDataType

Pointeur vers une variable qui reçoit une valeur qui spécifie le type de données de l’attribut demandé. Cette valeur est un énumérateur du type d’énumération EATTRIBUTE_DATATYPE , qui est défini dans printoem.h.

[out] ppbData

Pointeur vers une mémoire tampon allouée par un appelé contenant les données demandées. Une fois cette méthode terminée, l’appelant n’a pas besoin de libérer cette mémoire tampon.

[out] pcbSize

Pointeur vers une variable qui spécifie la taille, en octets, de la mémoire tampon vers laquelle pointe le paramètre pbData .

Valeur retournée

IPrintCoreHelperPS ::GetGlobalAttribute doit retourner l’une des valeurs suivantes.

Code de retour	Description
S_OK	S_OK
E_FAIL	Échec de la méthode.
E_INVALIDARG	La méthode a tenté d’interroger un attribut inexistant.
E_OUTOFMEMORY	La valeur dans pcbSize était inférieure au nombre d’octets à écrire dans la mémoire tampon de sortie pointée par pbData.

Remarques

Si IPrintCoreHelperPS ::GetGlobalAttribute est appelé avec ses paramètres pszAttribute et pbData définis sur NULL, la méthode retourne avec pcbSize défini sur le nombre d’octets nécessaires pour la liste de tous les noms d’attributs globaux pris en charge. Si cette méthode est appelée une deuxième fois, avec pszAttribute défini sur NULL et pbData pointant vers une mémoire tampon de la taille spécifiée dans pcbSize dans l’appel précédent, la méthode retourne avec pdwDataType défini sur kADT_ASCII (énumérateur du type d’énumération EATTRIBUTE_DATATYPE ) et pbData pointant vers une liste délimitée par NULL de tous les noms d’attributs globaux pris en charge. Cette liste se termine par deux caractères Null.