PropVariantToUInt32 関数 (propvarutil.h)

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

構文

PSSTDAPI PropVariantToUInt32(
  [in]  REFPROPVARIANT propvarIn,
  [out] ULONG          *pulRet
);

パラメーター

[in] propvarIn

型: REFPROPVARIANT

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

[out] pulRet

種類: ULONG*

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

戻り値

型: HRESULT

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

注釈

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

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

例

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

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

if (SUCCEEDED(hr))

{

     // PKEY_Rating is expected to produce a VT_UI4 or VT_EMPTY value.

     // PropVariantToUInt32 will convert VT_EMPTY to 0.

     ULONG uRating;

     hr = PropVariantToUInt32(propvar, &uRating);

     if (SUCCEEDED(hr))

     {

             // uRating is now valid

     }

     else

     {

             // uRating is always 0

     }

     PropVariantClear(&propvar);

}

要件

こちらもご覧ください

InitPropVariantFromUInt32

PropVariantChangeType

PropVariantToUInt32Vector

VariantToUInt32