IPrintCoreHelperPS::GetOptionAttribute メソッド (prcomoem.h)

[アーティクル]
08/07/2023

IPrintCoreHelperPS::GetOptionAttribute メソッドは、オプション属性リストまたは特定のオプション属性の値を取得します。

構文

HRESULT GetOptionAttribute(
  [in]  PCSTR  pszFeatureKeyword,
  [in]  PCSTR  pszOptionKeyword,
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

パラメーター

[in] pszFeatureKeyword

クエリ対象の機能キーワード (keyword)を指定する ANSI 文字列を含む、呼び出し元が指定したバッファーへのポインター。

[in] pszOptionKeyword

クエリ対象のオプションキーワード (keyword)を指定する ANSI 文字列を含む、呼び出し元が指定したバッファーへのポインター。この値は、 IPrintCoreHelperPS::EnumOptions の以前の呼び出しから取得できます。

[in] pszAttribute

要求された属性を指定する ANSI 文字列を含む、呼び出し元が指定したバッファーへのポインター。このパラメーターが NULL の場合、呼び出し元は、オプションに特定の属性名を指定する代わりに、オプションでサポートされているすべての属性名のリストを要求します。

[out] pdwDataType

要求された属性のデータ型を指定する値を受け取る変数へのポインター。この値は、printoem.h で定義されている EATTRIBUTE_DATATYPE 列挙型の列挙子です。

[out] ppbData

要求されたデータを含む呼び出し先割り当てバッファーへのポインター。このメソッドが完了すると、呼び出し元はこのバッファーを解放する必要はありません。

[out] pcbSize

pbData パラメーターによって指されるバッファーのサイズ (バイト単位) を受け取る変数へのポインター。

戻り値

IPrintCoreHelperPS::GetOptionAttribute は、次のいずれかの値を返す必要があります。

リターンコード	説明
S_OK	メソッドが成功しました。
E_FAIL	メソッドが失敗しました。
E_INVALIDARG	メソッドが存在しない属性を照会しようとしました。また、この値は、機能キーワード (keyword)名前またはオプションキーワード (keyword)名前が認識されなかったことを意味する場合もあります。
E_OUTOFMEMORY	pcbSize の値は、pbData が指す出力バッファーに書き込まれるバイト数よりも小さくなっています。

注釈

pszAttribute パラメーターと pbData パラメーターを NULL に設定して IPrintCoreHelperPS::GetOptionAttributeが呼び出された場合、このメソッドは pcbSize をオプションでサポートされているすべての属性名の一覧に必要なバイト数に設定してを返します。このメソッドが 2 回目に呼び出され、 pszAttribute が NULL に設定され、 pbData が前回の呼び出しで pcbSize で指定されたサイズのバッファーを指している場合、メソッドは pdwDataType を kADT_ASCII ( EATTRIBUTE_DATATYPE 列挙型の列挙子) に設定し、 pbData を返し、オプションでサポートされているすべての属性名の NULL 区切りリストを指します。このリストは、2 つの null 文字で終了します。