IPrintSchemaCapabilities2::GetParameterDefinition method

The GetParameterDefinition method retrieves the IPrintSchemaParameterDefinition object, and it represents the psf:ParameterDef element in the PrintCapabilites XML.

The keyword name and keyword namespace URI specify the IPrintSchemaParameterDefinition object to be retrieved.

Syntax

HRESULT GetParameterDefinition(
  BSTR                            bstrName,
  BSTR                            bstrNamespaceUri,
  IPrintSchemaParameterDefinition **ppParameterDefinition
);

Parameters

bstrName

The keyword name.

bstrNamespaceUri

The keyword namespace URI.

ppParameterDefinition

The IPrintSchemaParameterDefinition object.

Return value

The GetParameterDefinition method returns an HRESULT value. If the property call was not successful, it returns the appropriate HRESULT error code.

Remarks

To be consistent with IPrintSchemaCapabilities::GetFeature, the GetParameterDefinition method works for any psf:ParameterDef element that is defined in the public keyword namespaces. The GetParameterDefinition method also works for any IHV-defined private keyword namespace that uses either the StringParamType or the IntegerParamType data type.

When you use the psf:ParameterDef element with the QNameParamType or the DecimalParamType data type, GetParameterDefinition will return HRESULT_FROM_WIN32 (ERROR_NOT_SUPPORTED).

For more information about the data types that you can use with the psf:ParameterDef element, see section 2.1.3.1 of the Print Schema Specification.

Requirements

   
Minimum supported client Windows 8.1
Minimum supported server Windows Server 2012 R2
Target Platform Desktop
Header printerextension.h

See also

IPrintSchemaCapabilities2

IPrintSchemaParameterDefinition

Print Schema Specification