PropVariantToInt16WithDefault 関数 (propvarutil.h)
PROPVARIANT 構造体の Int16 プロパティ値を抽出します。 現在存在する値がない場合は、指定された既定値が返されます。
構文
PSSTDAPI_(SHORT) PropVariantToInt16WithDefault(
[in] REFPROPVARIANT propvarIn,
[in] SHORT iDefault
);
パラメーター
[in] propvarIn
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[in] iDefault
種類: SHORT
現在値が存在しない場合に使用する既定のプロパティ値を指定します。
戻り値
種類: SHORT
抽出された 短い 値 (既定値) を返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が Int16 値を保持することを想定し、そうでない場合は既定値を使用する場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して Int16 プロパティの SHORT 値を安全に抽出できます。
ソース PROPVARIANT に 型VT_I2がある場合、このヘルパー関数は Int16 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を SHORT に変換しようとします。 ソース PROPVARIANT に 型VT_EMPTY がある場合、または変換できない場合、 PropVariantToInt16WithDefault は iDefault によって提供される既定値を返します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | WINDOWS XP と SP2、Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | propvarutil.h |
| Library | Propsys.lib |
| [DLL] | Propsys.dll (バージョン 6.0 以降) |
| 再頒布可能パッケージ | Windows デスクトップ検索 (WDS) 3.0 |