PropVariantToDoubleWithDefault 関数 (propvarutil.h)
PROPVARIANT 構造体の double プロパティ値を抽出します。 値が存在しない場合は、指定された既定値が返されます。
構文
PSSTDAPI_(DOUBLE) PropVariantToDoubleWithDefault(
[in] REFPROPVARIANT propvarIn,
[in] DOUBLE dblDefault
);
パラメーター
[in] propvarIn
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[in] dblDefault
型: DOUBLE
現在値が存在しない場合に使用する既定のプロパティ値を指定します。
戻り値
型: DOUBLE
抽出された 倍精度浮動小数点 型 (default) の値を返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT で倍精度浮動小数点型 (DOUBLE) の値を保持することを想定し、それ以外の場合は既定値を使用する場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して、double プロパティの double 値を安全に抽出できます。
ソース PROPVARIANT に 型VT_R8がある場合、このヘルパー関数は double 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を double に変換しようとします。 ソース PROPVARIANT に 型VT_EMPTY がある場合、または変換できない場合、 PropVariantToDoubleWithDefault は dblDefault によって提供される既定値を返します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。
例
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Image_HorizontalResolution, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Image_HorizontalResolution is expected to produce a VT_R8 or VT_EMPTY value.
// The application developer decided to treat VT_EMPTY or invalid values as 72.0
DOUBLE dblResolution = PropVariantToDoubleWithDefault(propvar, 72.0);
// dblResolution is now valid.
PropVariantClear(&propvar);
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |