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

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

IPrintCoreHelperPS::GetOption メソッドは、特定の機能に対して指定されたオプションを取得します。

構文

HRESULT GetOption(
  [in, optional] const DEVMODE *pDevmode,
  [in]           DWORD         cbSize,
  [in]           PCSTR         pszFeatureRequested,
  [out]          PCSTR         *ppszOption
);

パラメーター

[in, optional] pDevmode

DEVMODEW構造体へのポインター。このポインターが指定されている場合、 IPrintCoreHelperPS::GetOption は、既定または現在の DEVMODEW 構造体ではなく 、pDevmode によって指される DEVMODEW 構造体を使用する必要があります。プラグインプロバイダーまたは IPrintOemPS::D evMode からこのメソッドを呼び出す場合は、このパラメーターが必要です。その他のほとんどの状況では、パラメーターは NULL にする必要があります。コアドライバーは 、pDevmode を NULL に設定すると、渡された DEVMODEW 構造体の状態ではなく、内部状態を変更します。これは、完全な UI 置換などの操作中に必要です。DDI によって返される DEVMODEW 構造体 ( DrvDocumentPropertySheets など) は、コアドライバーの UI モジュールによって処理されます。

[in] cbSize

pDevmode パラメーターによって指される DEVMODEW 構造体のサイズ (バイト単位)。

[in] pszFeatureRequested

PPD ファイルに表示されるフィーチャーの名前を含む ANSI 文字列へのポインター。

[out] ppszOption

ANSI 文字列のアドレスを含む変数へのポインター。 IPrintCoreHelperPS::GetOption が返されると、構成ファイルに表示される現在選択されているオプションのキーワード (keyword)が文字列に含まれている必要があります。呼び出し元はこの文字列を変更しないでください。また、この文字列に関連付けられているメモリを解放しないでください。

戻り値

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

リターンコード	説明
S_OK	メソッドは、指定された機能のオプションを読み取る。
E_FAIL	呼び出し元が、無効な要求の結果となった情報を提供しました。たとえば、要求された機能は存在しません。
E_INVALIDARG	引数が無効です。この値は、機能がサポートされていないこと、または機能に対して要求されたオプションが多すぎることを意味する可能性があります。
E_OUTOFMEMORY	メモリ不足のため、コアドライバーは要求をサービスできませんでした。
E_UNEXPECTED、またはここに記載されていないその他のリターンコード	コアドライバーが無効な状態になっているようです。呼び出し元はエラーコードを返す必要があります。

注釈

IPrintCoreHelperPS::GetOption は、複数のオプションを同時に設定できる機能には使用できません。

機能キーワードは、PPD ファイルで定義されているとおりです。さらに、Pscript5 ドライバーでは、プライベート DEVMODEW構造体に格納されているオプションの予約済みキーワードがいくつかサポートされています。 Pscript5 機能の一覧については、「キーワードマッピング」を参照してください。

呼び出し元は 、ppszOption によって指されている文字列を解放しないでください。また、文字列を何らかの方法で変更しないでください。