PropVariantToUInt64 関数 (propvarutil.h)

PROPVARIANT 構造体から UInt64 値を抽出します。 値を抽出できない場合は、既定値が割り当てられます。

構文

PSSTDAPI PropVariantToUInt64(
  [in]  REFPROPVARIANT propvarIn,
  [out] ULONGLONG      *pullRet
);

パラメーター

[in] propvarIn

型: REFPROPVARIANT

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

[out] pullRet

種類: ULONGLONG*

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

戻り値

種類: HRESULT

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

解説

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

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

例

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_Size, &propvar);

if (SUCCEEDED(hr))

{

     // PKEY_Size is expected to produce a VT_UI8 or VT_EMPTY value.

     // PropVariantToUInt64 will convert VT_EMPTY to 0.

     ULONGLONG ullSize;

     hr = PropVariantToUInt64(propvar, &ullSize);

     if (SUCCEEDED(hr))

     {

             // ullSize is now valid

     }

     else

     {

             // ullSize is always 0

     }

     PropVariantClear(&propvar);

}

要件

関連項目

InitPropVariantFromUInt64

PropVariantChangeType

PropVariantToUInt64Vector

VariantToUInt64