PropVariantToInt16 関数 (propvarutil.h)

PROPVARIANT 構造体の Int16 プロパティ値を抽出します。

構文

PSSTDAPI PropVariantToInt16(
  [in]  REFPROPVARIANT propvarIn,
  [out] SHORT          *piRet
);

パラメーター

[in] propvarIn

型: REFPROPVARIANT

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

[out] piRet

種類: SHORT*

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

戻り値

種類: HRESULT

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

注釈

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

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

例

大規模なプログラムの一部として含める次の例では、 PropVariantToInt16 を使用して PROPVARIANT の Int16 値にアクセスする方法を示します。

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

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

if (SUCCEEDED(hr))

{

     // PKEY_Image_ResolutionUnit is expected to produce a VT_I2 or VT_EMPTY value.

     // PropVariantToInt16 will convert VT_EMPTY to 0.

     INT16 iUnit;

     hr = PropVariantToInt16(propvar, & iUnit);

     if (SUCCEEDED(hr))

     {

             // iUnit is now valid

     }

     else

     {

             // iUnit 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