IPrintCoreHelperPS::EnumConstrainedOptions メソッド (prcomoem.h)
IPrintCoreHelperPS::EnumConstrainedOptions メソッドは、現在の設定に基づいて、特定の機能で制約されているすべてのオプションの一覧を提供します。
構文
HRESULT EnumConstrainedOptions(
[in, optional] IN const DEVMODE *pDevmode,
[in] IN DWORD cbSize,
[in] IN PCSTR pszFeatureKeyword,
[out] OUT PCSTR * [] pConstrainedOptionList,
[out] OUT DWORD *pdwNumOptions
);
パラメーター
[in, optional] pDevmode
DEVMODEW 構造体へのポインター。 このポインターが指定されている場合、 IPrintCoreHelperPS::EnumConstrainedOptions では、既定または現在の DEVMODEW 構造体ではなく 、pDevmode によって指される DEVMODEW 構造体を使用する必要があります。 プラグイン プロバイダーまたは IPrintOemPS::D evMode からこのメソッドを呼び出す場合は、このパラメーターが必要です。 その他のほとんどの状況では、 パラメーターは NULL にする必要があります。 コア ドライバーは 、pDevmode を NULL に設定すると、渡された DEVMODEW 構造体の状態ではなく、内部状態を変更します。 これは、完全な UI 置換などの操作中に必要です。DDI によって返される DEVMODEW 構造体 ( DrvDocumentPropertySheets など) は、コア ドライバーの UI モジュールによって処理されます。
[in] cbSize
pDevmode パラメーターによって指される DEVMODEW 構造体のサイズ (バイト単位)。
[in] pszFeatureKeyword
機能名を含む ANSI 文字の文字列。
[out] pConstrainedOptionList
ANSI 文字列の配列へのポインター。 IPrintCoreHelperPS::EnumConstrainedOptions が返されると、これらの文字列には、指定された機能内で制約されているすべてのオプションの名前が含まれます。 呼び出し元は、配列または配列内の個々の文字列を解放する責任を負いません。
[out] pdwNumOptions
pConstrainedOptionList パラメーターによって指される配列内の制約付きオプションの数を受け取る変数へのポインター。
戻り値
IPrintCoreHelperPS::EnumConstrainedOptions は、次のいずれかの値を返す必要があります。
| リターン コード | 説明 |
|---|---|
| S_OK | 制約付きオプションは、指定した機能に対して設定されました。 |
| E_FAIL | 呼び出し元は、存在しない機能の要求など、無効な要求を発生させた情報を提供しました。 |
| E_INVALIDARG | 1 つ以上の引数が無効でした。 この値は、この機能がサポートされていないことを意味する可能性があります。 |
| E_OUTOFMEMORY | オプション配列を作成するのに十分なメモリがなかったか、コア ドライバーがメモリ不足のため要求をサービスできませんでした。 |
| ここに 記載されていないE_UNEXPECTEDまたはその他のエラー | 予期しない状況になりました。 コア ドライバーが無効な状態である可能性があります。 呼び出し元は、エラー コードで終了する必要があります。 |
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | prcomoem.h (Prcomoem.h を含む) |