IPrintCoreUI2::GetFeatureAttribute メソッド (prcomoem.h)
メソッドは IPrintCoreUI2::GetFeatureAttribute 、特徴属性リストまたは特定の特徴属性の値を取得します。
構文
HRESULT GetFeatureAttribute(
[in] POEMUIOBJ poemuiobj,
[in] DWORD dwFlags,
[in] PCSTR pszFeatureKeyword,
[in] PCSTR pszAttribute,
[out] PDWORD pdwDataType,
[out] PBYTE pbData,
[in] DWORD cbSize,
[out] PDWORD pcbNeeded
);
パラメーター
[in] poemuiobj
現在のコンテキスト ( OEMUIOBJ 構造体) へのポインター。
[in] dwFlags
は予約済みであり、0 に設定する必要があります。
[in] pszFeatureKeyword
クエリを実行する 1 つの機能キーワード (keyword)を指定する ASCII 文字列を含む呼び出し元が指定したバッファーへのポインター。 この値は、 IPrintCoreUI2::EnumFeatures の以前の呼び出しから取得できます。
[in] pszAttribute
要求された 1 つの属性を指定する ASCII 文字列を含む呼び出し元が指定したバッファーへのポインター。 このパラメーターが NULL の場合、呼び出し元は、特定の機能属性名を指定するのではなく、サポートされているすべての機能属性名の一覧を要求します。
[out] pdwDataType
要求された属性のデータ型を指定する値を受け取るメモリ位置へのポインター。 この値は、printoem.h で定義されている EATTRIBUTE_DATATYPE 列挙の列挙子です。
[out] pbData
要求されたデータを受信する呼び出し元が指定したバッファーへのポインター。 要求を満たすために必要なバイト数をクエリするには、このパラメーターを NULL に設定 します。
[in] cbSize
によって指されるバッファーのサイズをバイト単位で pbData指定します。
[out] pcbNeeded
要求されたデータの実際のサイズ (バイト単位) を受け取るメモリ位置へのポインター。
戻り値
このメソッドは、次のいずれかの値を返す必要があります。
| リターン コード | 説明 |
|---|---|
|
メソッドが成功しました。 |
|
cbSize の値が、出力バッファー (pbData が指すバッファー) に書き込まれるバイト数よりも小さかった。
メソッドが呼び出され、 pbData が NULL に設定されました。 |
|
メソッドが存在しない属性のクエリを実行しようとしました。
機能キーワード (keyword)が認識されませんでした。 poemuiobj パラメーターが無効なコンテキスト オブジェクトを指しています。 |
|
メソッドが失敗しました |
注釈
このメソッドは、Unidrv プラグインではなく、Windows XP Pscript5 プラグインでのみサポートされています。
このメソッドが pszAttribute パラメーターと pbData パラメーターを NULL に設定して呼び出された場合、このメソッドは*pcbNeeded をフィーチャーでサポートされているすべての属性名のリストに必要なバイト数に設定して を返します。 メソッドが 2 回目に呼び出され、 pszAttribute が NULL に設定され、 pbData が前の呼び出しで *pcbNeeded で指定されたサイズのバッファーを指している場合、このメソッドは *pdwDataType を kADT_ASCII ( EATTRIBUTE_DATATYPE 列挙型の列挙子) に設定して、 pbData を返し、機能でサポートされているすべての属性名の null 区切りリストを指します。 このリストは、2 つの null 文字で終了します。
データ アクセスごとに 2 つの呼び出しを行う必要性を減らすには、メソッドに固定サイズの出力バッファー (たとえば 1 KB) を渡し、関数の戻り値をチェックします。 メソッドがS_OKを返す場合、バッファーには対象のデータが既に含まれています。 メソッドがE_OUTOFMEMORYを返す場合、*pcbNeeded の値は、目的のデータを保持するために必要なバッファー サイズです。 呼び出し元はそのサイズのバッファーを割り当て、メソッドの 2 番目の呼び出しを続行する必要があります。
詳細については、「 GetFeatureAttribute の使用」を参照してください。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | デスクトップ |
| Header | prcomoem.h (Prcomoem.h を含む) |
こちらもご覧ください
IPrintCoreUI2::GetGlobalAttribute