PropVariantToUInt16WithDefault 関数 (propvarutil.h)
PROPVARIANT 構造体から符号なし短い値を抽出します。 値が存在しない場合は、指定された既定値が返されます。
構文
PSSTDAPI_(USHORT) PropVariantToUInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] USHORT uiDefault
);
パラメーター
[in] propvarIn
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[in] uiDefault
種類: USHORT
現在値が存在しない場合に使用する既定のプロパティ値を指定します。
戻り値
型: unsigned short
抽出された 符号なし短い 値 (既定値) を返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が 符号なし短い 値を保持することを想定している場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して、UInt16 プロパティの 符号なし短い 値を安全に抽出できます。
ソース PROPVARIANT に 型VT_UI2がある場合、このヘルパー関数は 符号なし短い 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を 符号なし short に変換しようとします。 変換できない場合、 PropVariantToUInt16 はエラー コードを返し、 puiRet を 0 に設定します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。 特に、 VT_EMPTY は正常に 0 に変換されます。
例
より大きなプログラムの一部として含める次の例は、PropVariantToUInt16 を使用して PROPVARIANT の符号なし短い値にアクセスする方法を示しています。
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagColor, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagColor is expected to produce a VT_UI2 or VT_EMPTY value.
// PropVariantToInt32 will convert VT_EMPTY to 0.
USHORT uColor;
hr = PropVariantToUInt32(propvar, & uColor);
if (SUCCEEDED(hr))
{
// uColor is now valid
}
else
{
// uColor is always 0
}
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 |