IPrintCoreHelperPS::GetOptionAttribute 方法 (prcomoem.h)
IPrintCoreHelperPS::GetOptionAttribute 方法會擷取選項屬性清單或特定選項屬性的值。
語法
HRESULT GetOptionAttribute(
[in] PCSTR pszFeatureKeyword,
[in] PCSTR pszOptionKeyword,
[in] PCSTR pszAttribute,
[out] PDWORD pdwDataType,
[out] PBYTE *ppbData,
[out] PDWORD pcbSize
);
參數
[in] pszFeatureKeyword
呼叫端提供的緩衝區指標,其中包含 ANSI 字串,指定要查詢的功能關鍵詞。
[in] pszOptionKeyword
呼叫端提供的緩衝區指標,其中包含 ANSI 字串,指定要查詢的選項關鍵詞。 此值可以從 先前呼叫 IPrintCoreHelperPS::EnumOptions 取得。
[in] pszAttribute
呼叫端提供的緩衝區指標,其中包含指定所要求屬性的 ANSI 字串。 如果此參數為 NULL,呼叫端會要求選項所有支援的屬性名稱清單,而不是指定選項的特定屬性名稱。
[out] pdwDataType
接收指定所要求屬性數據類型之值之變數的指標。 這個值是 EATTRIBUTE_DATATYPE 列舉類型的列舉值,定義於printoem.h中。
[out] ppbData
包含所要求數據的被呼叫端配置緩衝區指標。 完成此方法時,呼叫端不需要釋放這個緩衝區。
[out] pcbSize
接收 pbData 參數所指向之緩衝區大小的變數指標,以位元組為單位。
傳回值
IPrintCoreHelperPS::GetOptionAttribute 應該會傳回下列其中一個值。
傳回碼 | 描述 |
---|---|
S_OK | 此方法已成功。 |
E_FAIL | 方法失敗。 |
E_INVALIDARG | 方法嘗試查詢不存在的屬性。 這個值也可能表示無法辨識功能關鍵詞名稱或選項關鍵詞名稱。 |
E_OUTOFMEMORY | 在 sqlSize 中的值小於要寫入 pbData 所指向之輸出緩衝區的位元元組數目。 |
備註
如果使用其 pszAttribute 和 pbData 參數設定為 NULL 呼叫 IPrintCoreHelperPS::GetOptionAttribute,則方法會傳回設定為選項之所有支援屬性名稱清單所需的位元組數目。 如果第二次呼叫此方法,並將 pszAttribute 設定為 NULL ,而 pbData 指向先前呼叫中 指定 之大小的緩衝區,則方法會傳回 pdwDataType 設定為 kADT_ASCII (EATTRIBUTE_DATATYPE 列舉類型的 列舉值) ,而 pbData 指向選項所有支援屬性名稱的 NULL 分隔清單。 此清單會以兩個 Null 字元終止。
如需 IPrintCoreHelperPS::GetOptionAttribute 的詳細資訊,請參閱 使用 GetOptionAttribute。
規格需求
需求 | 值 |
---|---|
目標平台 | 桌面 |
標頭 | prcomoem.h (包含 Prcomoem.h) |