Méthode IPrintCoreHelperPS ::GetOptionAttribute (prcomoem.h)

Article
02/29/2024

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

Syntaxe

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

Paramètres

[in] pszFeatureKeyword

Pointeur vers une mémoire tampon fournie par l’appelant qui contient une chaîne ANSI qui spécifie la fonctionnalité mot clé à interroger.

[in] pszOptionKeyword

Pointeur vers une mémoire tampon fournie par l’appelant qui contient une chaîne ANSI qui spécifie l’option mot clé à interroger. Cette valeur peut être obtenue à partir d’un appel précédent à IPrintCoreHelperPS ::EnumOptions.

[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 pris en charge pour l’option au lieu de spécifier un nom d’attribut spécifique pour l’option.

[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 appelée et allouée 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 reçoit la taille, en octets, de la mémoire tampon vers laquelle pointe le paramètre pbData .

Valeur retournée

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

Code de retour	Description
S_OK	S_OK
E_FAIL	La méthode a échoué.
E_INVALIDARG	La méthode a tenté d’interroger un attribut inexistant. Cette valeur peut également signifier que la fonctionnalité mot clé nom ou l’option mot clé nom n’ont pas été reconnus.
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 ::GetOptionAttributeest 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’attribut pris en charge pour l’option. 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 lors de 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’attribut pris en charge pour l’option. Cette liste se termine par deux caractères null.