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

Article
02/07/2025

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 le mot clé de fonctionnalité à interroger.

[in] pszOptionKeyword

Pointeur vers une mémoire tampon fournie par l’appelant qui contient une chaîne ANSI qui spécifie le mot clé d’option à interroger. Cette valeur peut être obtenue à partir d’un appel antérieur à 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 est 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 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 reçoit la taille, en octets, de la mémoire tampon pointée par le paramètre pbData.

Valeur de retour

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

Retourner le code	Description
S_OK	La méthode a réussi.
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 le nom du mot clé de fonctionnalité ou le nom du mot clé d’option n’ont pas été reconnus.
E_OUTOFMEMORY	La valeur de pbData était inférieure au nombre d’octets à écrire dans la mémoire tampon de sortie pointée par pbData.

Remarques

Si IPrintCoreHelperPS ::GetOptionAttribute est appelé avec son pszAttribute et paramètres pbData définis sur NULL, la méthode retourne avec cspSize défini sur le nombre d’octets nécessaires pour la liste de tous les noms d’attributs 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 à 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 l’ensemble de l’attribut pris en charge noms de l’option. Cette liste est terminée avec deux caractères Null.

Pour plus d’informations sur IPrintCoreHelperPS ::GetOptionAttribute, consultez Using GetOptionAttribute.