Méthode IPrintSchemaCapabilities ::GetFeatureByKeyName (printerextension.h)

Article
03/01/2024

Obtient une fonctionnalité à partir de PrintCapabilities en fonction d’un nom de clé donné.

Syntaxe

HRESULT GetFeatureByKeyName(
  [in]          BSTR                bstrKeyName,
  [out, retval] IPrintSchemaFeature **ppFeature
);

Paramètres

[in] bstrKeyName

Nom de clé de la fonctionnalité.

[out, retval] ppFeature

Fonctionnalité retournée.

Valeur retournée

Cette méthode retourne une valeur HRESULT .

Remarques

Seuls les noms de clés de fonctionnalité suivants sont reconnus. Les noms de clés sont équivalents aux noms de fonctionnalités de schéma d’impression publics, comme indiqué dans le tableau suivant. Le tableau montre également les fonctionnalités qui ont des types d’options spécialisés (par défaut, le type d’option est IPrintSchemaOption).

Nom	Nom public de la fonctionnalité de schéma d’impression	Type d’option spécialisée
DocumentBinding	DocumentBinding ou JobBindAllDocuments
DocumentCollate	DocumentCollate
DocumentDuplex	JobDuplexAllDocumentsContiguously
DocumentHolePunch	DocumentHolePunch ou JobHolePunch
DocumentInputBin	JobInputBin, DocumentInputBin ou PageInputBin
DocumentNUp	JobNUpAllDocumentsContiguously	IPrintSchemaNUpOption
DocumentStaple	JobStapleAllDocuments ou DocumentStaple
PageMediaSize	PageMediaSize	IPrintSchemaPageMediaSizeOption
PageMediaType	PageMediaType
PageOrientation	PageOrientation
PageOutputColor	PageOutputColor
PageOutputQuality	PageOutputQuality

Lorsque la fonctionnalité, l’option ou la propriété demandée est introuvable, cette méthode retourne S_FALSE et définit un pointeur NULL sur l’objet de sortie de la fonctionnalité, de l’option ou de la propriété.

Par conséquent, si l’objet IPrintSchemaTicket ne contient pas la fonctionnalité, l’option ou la propriété spécifiée, l’application doit obtenir un objet IPrintSchemaCapabilities et l’interroger via IPrintSchemaCapabilities ::GetFeatureByKeyName ou via IPrintSchemaCapabilities ::GetFeature.