IPrintSchemaTicket::GetFeatureByKeyName method

Gets a feature from the PrintTicket based on the specified key name.

Syntax


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

Parameters

bstrKeyName [in]

The key name of the feature.

ppFeature [out, retval]

The returned feature.

Return value

This method returns an HRESULT value.

Remarks

See IPrintSchemaCapabilities::GetFeatureByKeyName for the recognized feature key names, the key names’ equivalent public Print Schema feature names, and the supported specialized option types.

When the requested feature, option or property is not found, this method returns S_FALSE and sets a NULL pointer on the output object of the feature, option or property.

So if the IPrintSchemaTicket object does not contain the specified feature, option or property, the app must obtain an IPrintSchemaCapabilities object and query it via IPrintSchemaCapabilities::GetFeatureByKeyName or via IPrintSchemaCapabilities::GetFeature.

Requirements

Version

Windows 8

Header

Printerextension.h

See also

IPrintSchemaTicket
IPrintSchemaCapabilities
IPrintSchemaCapabilities::GetFeature
IPrintSchemaCapabilities::GetFeatureByKeyName
IPrintSchemaFeature

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft