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

Artículo
08/07/2023

Obtiene una característica de PrintCapabilities basada en un nombre de clave determinado.

Sintaxis

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

Parámetros

[in] bstrKeyName

Nombre de clave de la característica.

[out, retval] ppFeature

Característica devuelta.

Valor devuelto

Este método devuelve un valor HRESULT .

Comentarios

Solo se reconocen los siguientes nombres de clave de característica. Los nombres de clave son equivalentes a los nombres de características de esquema de impresión públicos, como se muestra en la tabla siguiente. La tabla también muestra las características que tienen tipos de opción especializados (de forma predeterminada, el tipo de opción es IPrintSchemaOption).

Nombre	Nombre público de la característica de esquema de impresión	Tipo de opción especializado
DocumentBinding	DocumentBinding o JobBindAllDocuments
DocumentCollate	DocumentCollate
DocumentDuplex	JobDuplexAllDocumentsContiguously
DocumentHolePunch	DocumentHolePunch o JobHolePunch
DocumentInputBin	JobInputBin, DocumentInputBin o PageInputBin
DocumentNUp	JobNUpAllDocumentsContiguously	IPrintSchemaNUpOption
DocumentStaple	JobStapleAllDocuments o DocumentStaple
PageMediaSize	PageMediaSize	IPrintSchemaPageMediaSizeOption
PageMediaType	PageMediaType
PageOrientation	PageOrientation
PageOutputColor	PageOutputColor
PageOutputQuality	PageOutputQuality

Cuando no se encuentra la característica solicitada, la opción o la propiedad, este método devuelve S_FALSE y establece un puntero NULL en el objeto de salida de la característica, la opción o la propiedad.

Por lo tanto, si el objeto IPrintSchemaTicket no contiene la característica, opción o propiedad especificadas, la aplicación debe obtener un objeto IPrintSchemaCapabilities y consultarlo a través de IPrintSchemaCapabilities::GetFeatureByKeyName o a través de IPrintSchemaCapabilities::GetFeature.