PropVariantToInt32 関数 (propvarutil.h)
PROPVARIANT 構造体の Int32 プロパティ値を抽出します。 値を抽出できない場合は、既定値が割り当てられます。
構文
PSSTDAPI PropVariantToInt32(
[in] REFPROPVARIANT propvarIn,
[out] LONG *plRet
);
パラメーター
[in] propvarIn
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[out] plRet
型: LONG*
この関数が戻るときに、抽出された値が存在する場合は を格納します。それ以外の場合は 0。
戻り値
型: HRESULT
この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。
注釈
このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が Int32 値を保持することを想定している場所で使用されます。 たとえば、プロパティ ストアから値を取得するアプリケーションでは、これを使用して Int32 プロパティの Int32 値を安全に抽出できます。
ソース PROPVARIANT に 型VT_I4がある場合、このヘルパー関数は 長い 値を抽出します。 それ以外の場合は、 PROPVARIANT 構造体の値を long に変換しようとします。 変換できない場合、 PropVariantToInt32 はエラー コードを返し、 plRet を 0 に設定します。 可能な変換の一覧については、「 PropVariantChangeType 」を参照してください。 なお、 VT_EMPTY は正常に 0 に変換されます。
例
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FlagStatus, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_FlagStatus is expected to produce a VT_I4 or VT_EMPTY value.
// PropVariantToInt32 will convert VT_EMPTY to 0.
INT32 iStatus;
hr = PropVariantToInt32(propvar, &iStatus);
if (SUCCEEDED(hr))
{
// iStatus is now valid
}
else
{
// iStatus 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 |