Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 3.55 KB

nf-printerextension-iprintschemacapabilities2-getparameterdefinition.md

File metadata and controls

80 lines (60 loc) · 3.55 KB
Raw
UID title description tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:printerextension.IPrintSchemaCapabilities2.GetParameterDefinition
IPrintSchemaCapabilities2::GetParameterDefinition (printerextension.h)
The GetParameterDefinition method retrieves the IPrintSchemaParameterDefinition object, and it represents the psf:ParameterDef element in the PrintCapabilites XML.
print
08/02/2022
IPrintSchemaCapabilities2::GetParameterDefinition
GetParameterDefinition, GetParameterDefinition method [Print Devices], GetParameterDefinition method [Print Devices],IPrintSchemaCapabilities2 interface, IPrintSchemaCapabilities2 interface [Print Devices],GetParameterDefinition method, IPrintSchemaCapabilities2.GetParameterDefinition, IPrintSchemaCapabilities2::GetParameterDefinition, print.iprintschemacapabilities2_getparameterdefinition, printerextension/IPrintSchemaCapabilities2::GetParameterDefinition
printerextension.h
Desktop
Windows 8.1
Windows Server 2012 R2
Windows
IPrintSchemaCapabilities2::GetParameterDefinition
printerextension/IPrintSchemaCapabilities2::GetParameterDefinition
APIRef
kbSyntax
COM
Printerextension.h
IPrintSchemaCapabilities2::GetParameterDefinition

-description

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.

-parameters

-param bstrName [in]

The keyword name

-param bstrNamespaceUri [in]

The keyword namespace URI

-param ppParameterDefinition [out, retval]

The IPrintSchemaParameterDefinition object

-returns

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.

-see-also

IPrintSchemaCapabilities2

IPrintSchemaParameterDefinition

Print Schema Specification