IPrintSchemaFeature::GetOption method

Gets the option with the given name.

Syntax


HRESULT GetOption(
  [in]          BSTR               bstrName,
  [in]          BSTR               bstrNamespaceUri = PRINTSCHEMA_KEYWORDS_NAMESPACE_URI,
  [out, retval] IPrintSchemaOption **ppOption
);

Parameters

bstrName [in]

The name of the option.

bstrNamespaceUri [in]

The namespace URI of the option.

ppOption [out, retval]

The returned option.

Return value

This method returns an HRESULT value, if the call was successful. Otherwise it returns the appropriate error code.

Remarks

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

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Target platform

Header

Printerextension.h

See also

IPrintSchemaCapabilities
IPrintSchemaFeature
IPrintSchemaTicket
IPrintSchemaOption

 

 

Send comments about this topic to Microsoft

Show: