IPrintCoreHelperUni::GetOption 方法 (prcomoem.h)
IPrintCoreHelperUni::GetOption
方法获取给定功能的指定选项。
语法
HRESULT GetOption(
[in, optional] const DEVMODE *pDevmode,
[in] DWORD cbSize,
[in] PCSTR pszFeatureRequested,
[out] PCSTR *ppszOption
);
参数
[in, optional] pDevmode
指向 DEVMODEW 结构的指针。 如果提供了此指针,IPrintCoreHelperUni::GetOption
应使用由 pDevmode 而不是默认或当前 DEVMODEW 结构指向的 DEVMODEW 结构。 如果从插件提供程序或从 IPrintOemUni::D evMode调用此方法,则需要此参数。 在大多数其他情况下,参数应 NULL。 当核心驱动程序 pDevmode 设置为 NULL时,它会修改其内部状态,而不是传入 DEVMODEW 结构的内部状态。 在完全 UI 替换等作期间,需要执行此作,其中 DDI 返回的 DEVMODEW 结构(如 DrvDocumentPropertySheets)由核心驱动程序的 UI 模块提供服务。
[in] cbSize
pDevmode 参数指向的 DEVMODEW 结构的大小(以字节为单位)。
[in] pszFeatureRequested
指向 ANSI 字符串的指针,该字符串包含 GPD 文件中显示的功能的名称。
[out] ppszOption
指向包含 ANSI 字符串地址的变量的指针。 当 IPrintCoreHelperUni::GetOption
返回时,字符串应包含当前所选选项的关键字,因为它显示在配置文件中。 调用方不应修改此字符串,不应释放与此字符串关联的内存。
返回值
IPrintCoreHelperUni::GetOption
应返回以下值之一。
返回代码 | 描述 |
---|---|
|
该方法读取指定功能的选项。 |
|
调用方提供了导致无效请求的信息。 例如,请求的功能不存在。 |
|
参数无效。 此值可能意味着不支持该功能或请求了太多选项。 |
|
核心驱动程序无法为请求提供服务,因为内存不足。 |
|
核心驱动程序似乎处于无效状态。 调用方应返回失败代码。 |
言论
IPrintCoreHelperUni::GetOption
不能用于允许同时设置多个选项的功能。
功能关键字在 GPD 文件中定义。 此外,Unidrv 驱动程序还支持多个保留关键字用于存储在其专用 DEVMODEW 结构中的选项。 有关 Unidrv 功能的列表,请参阅 关键字映射。
调用方不应释放由 ppszOption 指向的字符串,并且不应以任何方式修改字符串。
要求
要求 | 价值 |
---|---|
目标平台 | 桌面 |
标头 | prcomoem.h (include Prcomoem.h) |