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

Artigo
02/26/2024

Obtém um recurso do PrintCapabilities com base em um determinado nome de chave.

Sintaxe

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

Parâmetros

[in] bstrKeyName

O nome da chave do recurso.

[out, retval] ppFeature

O recurso retornado.

Retornar valor

Esse método retorna um valor HRESULT .

Comentários

Somente os nomes de chave de recurso a seguir são reconhecidos. Os nomes de chave são equivalentes aos nomes de recursos públicos do Esquema de Impressão, conforme mostrado na tabela a seguir. A tabela também mostra os recursos que têm tipos de opção especializados (por padrão, o tipo de opção é IPrintSchemaOption).

Nome	Nome público do recurso de esquema de impressão	Tipo de opção especializada
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

Quando o recurso solicitado, a opção ou a propriedade não é encontrado, esse método retorna S_FALSE e define um ponteiro NULL no objeto de saída do recurso, opção ou propriedade.

Portanto, se o objeto IPrintSchemaTicket não contiver o recurso, a opção ou a propriedade especificados, o aplicativo deverá obter um objeto IPrintSchemaCapabilities e consultá-lo por meio de IPrintSchemaCapabilities::GetFeatureByKeyName ou via IPrintSchemaCapabilities::GetFeature.