PropVariantToDouble 関数 (propvarutil.h)

PROPVARIANT 構造体から double 値を抽出します。

構文

PSSTDAPI PropVariantToDouble(
  [in]  REFPROPVARIANT propvarIn,
  [out] DOUBLE         *pdblRet
);

パラメーター

[in] propvarIn

型: REFPROPVARIANT

ソース PROPVARIANT 構造体への参照。

[out] pdblRet

種類: DOUBLE*

この関数が戻るときに、抽出されたプロパティ値 (存在する場合) が格納されます。それ以外の場合は、0.0 が含まれます。

戻り値

型: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

解説

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT で 1 つの二重浮動小数点値を保持することを想定している場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して、double プロパティの二重値を安全に抽出できます。

ソース PROPVARIANT に 型VT_R8がある場合、このヘルパー関数は double 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を double に変換しようとします。 変換できない場合、 PropVariantToDouble はエラー コードを返し、 pdblRet を 0.0 に設定します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。 なお、 VT_EMPTY は正常に 0.0 に変換されます。

例

次の例は、より大きなプログラムの一部として含めるために、PropVariantToDouble を使用して PROPVARIANT の二重値にアクセスする方法を示しています。

// 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.
     // PropVariantToDouble will successfully convert VT_EMPTY to a 0.0.
     DOUBLE dblHorzResolution;
     hr = PropVariantToDouble(propvar, &dblHorzResolution);
     if (SUCCEEDED(hr))
     {
        // dblHorzResolution is now valid
     }
     else
     {
        // dblHorzResolution contains 0.0
     }
     PropVariantClear(&propvar);
}

要件

関連項目

InitPropVariantFromDouble

PropVariantGetDoubleElem

PropVariantToDoubleWithDefault

VariantToDouble