IPrintCorePS2::EnumOptions メソッド (prcomoem.h)

  • [アーティクル]

メソッドは IPrintCorePS2::EnumOptions 、特定の機能の使用可能なオプションを列挙します。

構文

HRESULT EnumOptions(
  [in]  PDEVOBJ pdevobj,
  [in]  DWORD   dwFlags,
  [in]  PCSTR   pszFeatureKeyword,
  [out] PSTR    pmszOptionList,
  [in]  DWORD   cbSize,
  [out] PDWORD  pcbNeeded
);

パラメーター

[in] pdevobj

DEVOBJ 構造体へのポインター。

[in] dwFlags

は予約されており、0 に設定する必要があります。

[in] pszFeatureKeyword

オプションが要求される機能キーワード (keyword)を指定する、ASCII 文字列を含む呼び出し元が指定したバッファーへのポインター。

[out] pmszOptionList

pszFeatureKeyword が指す機能のオプション キーワードを含む、MULTI_SZ形式で null で区切られたリストを受け取る呼び出し元指定バッファーへのポインターキーワード (keyword)。 このリストは、2 つの null 文字で終了します。

リストを入力せずにオプション・リストのサイズ (*pcbNeeded) を照会するには、このパラメーターを NULL に設定します。

[in] cbSize

pmszOptionList が指すバッファーのサイズをバイト単位で指定します。

[out] pcbNeeded

要求されたデータの実際のサイズ (バイト単位) を受け取るメモリ位置へのポインター。

戻り値

このメソッドは、次のいずれかの値を返す必要があります。

リターン コード 説明
S_OK
 メソッドが成功しました。
E_OUTOFMEMORY
 cbSize の値が、出力バッファーに書き込まれるバイト数 (pmszOptionList が指すバッファー) よりも小さくなっています。

pmszOptionList を NULL に設定してメソッドが呼び出されました。
E_INVALIDARG
 pszFeatureKeyword が指す文字列は、認識された機能ではありません。

無効なドライバー コンテキスト オブジェクトを指す pdevobj パラメーター。
E_NOTIMPL
 (Pscript のみ)

Pscript5 ドライバー機能は、現在の構成ではサポートされていません。

Pscript5 ドライバー機能は現在の構成でサポートされていますが、Pscript5 ドライバー機能のオプションは列挙できません。
E_FAIL
 メソッドが失敗しました。

注釈

データ アクセスごとに 2 つの呼び出しを行う必要性を減らすには、メソッドに固定サイズ (1 KB など) の出力バッファーを渡し、関数の戻り値をチェックします。 メソッドがS_OKを返す場合、バッファーには既に目的のデータが含まれています。 メソッドがE_OUTOFMEMORYを返す場合、*pcbNeeded の値は目的のデータを保持するために必要なバッファー サイズです。 呼び出し元は、その大きなサイズのバッファーを割り当て、メソッドの 2 回目の呼び出しを続行する必要があります。

このメソッドは、Pscript5 レンダー プラグインでサポートされています。

詳細については、「 EnumOptions の使用」を参照してください。

要件

要件 値
対象プラットフォーム デスクトップ
Header prcomoem.h (Prcomoem.h を含む)

こちらもご覧ください

DEVOBJ

IPrintCorePS2

IPrintCorePS2::EnumFeatures