IPrintCoreUI2：：GetOptionAttribute 方法（prcomoem.h）

2025-02-07

IPrintCoreUI2::GetOptionAttribute 方法检索选项属性列表或特定选项属性的值。

语法

HRESULT GetOptionAttribute(
  [in]  POEMUIOBJ poemuiobj,
  [in]  DWORD     dwFlags,
  [in]  PCSTR     pszFeatureKeyword,
  [in]  PCSTR     pszOptionKeyword,
  [in]  PCSTR     pszAttribute,
  [out] PDWORD    pdwDataType,
  [out] PBYTE     pbData,
  [in]  DWORD     cbSize,
  [out] PDWORD    pcbNeeded
);

参数

[in] poemuiobj

指向当前上下文的指针，OEMUIOBJ 结构。

[in] dwFlags

保留并且必须设置为零。

[in] pszFeatureKeyword

指向调用方提供的缓冲区的指针，该缓冲区包含一个 ASCII 字符串，该字符串指定要查询的单个功能关键字。

[in] pszOptionKeyword

指向调用方提供的缓冲区的指针，该缓冲区包含指定要查询的单个选项关键字的 ASCII 字符串。可以从之前调用 IPrintCoreUI2：：EnumOptions获取此值。

[in] pszAttribute

指向调用方提供的缓冲区的指针，该缓冲区包含指定所请求的单个属性的 ASCII 字符串。如果此参数 NULL，则调用方将请求选项支持的所有属性名称的列表，而不是指定选项的特定属性名称。

[out] pdwDataType

指向接收指定所请求属性数据类型的值的内存位置的指针。此值是 EATTRIBUTE_DATATYPE 枚举的枚举器。

[out] pbData

指向接收请求数据的调用方提供的缓冲区的指针。若要仅查询满足请求所需的字节数，请将此参数设置为 NULL。

[in] cbSize

指定 pbData指向的缓冲区的大小（以字节为单位）。

[out] pcbNeeded

指向接收所请求数据的实际大小（以字节为单位）的内存位置的指针。

返回值

此方法必须返回以下值之一。

返回代码	描述
S_OK	方法成功。
E_OUTOFMEMORY	cbSize 中的值小于要写入输出缓冲区的字节数（pbData指向的缓冲区）。调用此方法时，pbData 设置为 NULL 。
E_INVALIDARG	该方法尝试查询不存在的属性。无法识别功能关键字名称或选项关键字名称。 poemuiobj 参数指向无效的上下文对象。
E_FAIL	方法失败

言论

此方法仅支持 Windows XP Pscript5 插件，而不支持 Unidrv 插件。

如果使用其 pszAttribute 调用此方法，并将 pbData 参数设置为 NULL，则该方法返回的值为 * 设置为该选项的所有受支持属性名称列表所需的字节数。如果第二次调用该方法，pszAttribute 设置为 NULL，pbData 指向上一次调用中指定的 * 中指定的大小的缓冲区，此方法返回的值为 *pdwDataType 设置为kADT_ASCII（EATTRIBUTE_DATATYPE 枚举类型的枚举器），pbData 指向该选项支持的所有属性名称的空分隔列表。此列表以两个 null 字符结尾。

若要减少对每个数据访问进行两次调用的需要，请传递方法，该缓冲区的大小固定（例如 1 KB），然后检查函数返回值。如果方法返回S_OK，则缓冲区已包含感兴趣的数据。如果方法返回E_OUTOFMEMORY，则 * 中的值是保存感兴趣的数据的缓冲区大小。然后，调用方应分配该较大大小的缓冲区，并继续对方法进行第二次调用。

有关详细信息，请参阅使用 GetOptionAttribute。