PropVariantToUInt32WithDefault 関数 (propvarutil.h)
PROPVARIANT 構造体から ULONG 値を抽出します。 値が存在しない場合は、指定された既定値が返されます。
構文
PSSTDAPI_(ULONG) PropVariantToUInt32WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] ULONG ulDefault
);
パラメーター
[in] propvarIn
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[in] ulDefault
種類: ULONG
現在値が存在しない場合に使用する既定のプロパティ値を指定します。
戻り値
種類: ULONG
抽出された ULONG 値 (既定値) を返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が ULONG 値を保持することを想定し、そうでない場合は既定値を使用する場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して UInt32 プロパティの ULONG 値を安全に抽出できます。
ソース PROPVARIANT に 型VT_UI4がある場合、このヘルパー関数は ULONG 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を ULONG に変換しようとします。 ソース PROPVARIANT に 型VT_EMPTY がある場合、または変換できない場合、 PropVariantToUInt32WithDefault は ulDefault によって提供される既定値を返します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。
例
より大きなプログラムの一部として含める次の例では、PropVariantToUInt32WithDefault を使用して 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.
// The application developer decided to treat VT_EMPTY or invalid values as 0
ULONG uRating = PropVariantToUInt32WithDefault(propvar, 0);
// uRating 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 |