Skip to content

Latest commit

 

History

History
140 lines (109 loc) · 4.29 KB

nf-prcomoem-iprintoemdriverui-drvgetdriversetting.md

File metadata and controls

140 lines (109 loc) · 4.29 KB
Raw
UID title description old-location 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:prcomoem.IPrintOemDriverUI.DrvGetDriverSetting
IPrintOemDriverUI::DrvGetDriverSetting (prcomoem.h)
The IPrintOemDriverUI::DrvGetDriverSetting method is provided by the Unidrv and Pscript5 minidrivers so that user interface plug-ins can obtain the current status of printer features and other internal information.
print\iprintoemdriverui_drvgetdriversetting.htm
print
04/20/2018
IPrintOemDriverUI::DrvGetDriverSetting
DrvGetDriverSetting, DrvGetDriverSetting method [Print Devices], DrvGetDriverSetting method [Print Devices],IPrintOemDriverUI interface, IPrintOemDriverUI interface [Print Devices],DrvGetDriverSetting method, IPrintOemDriverUI.DrvGetDriverSetting, IPrintOemDriverUI::DrvGetDriverSetting, prcomoem/IPrintOemDriverUI::DrvGetDriverSetting, print.iprintoemdriverui_drvgetdriversetting, print_unidrv-pscript_ui_3685add0-a9b4-43c3-9a5e-665e1f6f2034.xml
prcomoem.h
Prcomoem.h
Desktop
Windows
IPrintOemDriverUI::DrvGetDriverSetting
prcomoem/IPrintOemDriverUI::DrvGetDriverSetting
APIRef
kbSyntax
COM
prcomoem.h
IPrintOemDriverUI::DrvGetDriverSetting

IPrintOemDriverUI::DrvGetDriverSetting

-description

The IPrintOemDriverUI::DrvGetDriverSetting method is provided by the Unidrv and Pscript5 minidrivers so that user interface plug-ins can obtain the current status of printer features and other internal information.

-parameters

-param pci

Caller-supplied pointer to an OEMUIOBJ structure.

-param Feature

Caller-supplied value identifying the printer feature for which option settings are returned. This can be either a string pointer or a constant, as described in the following Remarks section.

-param pOutput

Caller-supplied pointer to a buffer to receive the specified information.

-param cbSize

Caller-supplied size, in bytes, of the buffer pointed to by pOutput.

-param pcbNeeded

Caller-supplied pointer to a location to receive the minimum buffer size required to contain the requested information.

-param pdwOptionsReturned

Caller-supplied pointer to a location to receive the number of option strings placed in pOutput.

-returns

The method must return one of the following values.

Return code Description
S_OK
 The operation succeeded.
E_FAIL
 The operation failed.
E_NOTIMPL
 The method is not implemented.

-remarks

When calling the IPrintOemDriverUI::DrvGetDriverSetting method, a user interface plug-in can specify either a string pointer or a constant value for pFeatureKeyword.

  • If pFeatureKeyword is a string, it must represent one of the following:
    • A feature name specified in a Unidrv minidriver GPD file, or,
    • A keyword argument to an *OpenUI entry in a Pscript5 minidriver's PPD file.

    The method returns one or more NULL-terminated strings in the buffer pointed to by pOutput. Each string represents the name of a currently selected option.The number of strings is returned in pdwOptionsReturned.

  • If pFeatureKeyword is a constant, it must be one of the OEMGDS_-prefixed constants defined in printoem.h. The method returns the value indicated by the specified constant by placing it in the buffer pointed to by pOutput. The value returned in pdwOptionsReturned is always 1.