PropVariantToInt16Vector 関数 (propvarutil.h)

[アーティクル]
03/05/2024

PROPVARIANT 構造体から Int16 値のベクターを抽出します。

構文

PSSTDAPI PropVariantToInt16Vector(
  [in]  REFPROPVARIANT propvar,
  [out] SHORT          *prgn,
  [in]  ULONG          crgn,
  [out] ULONG          *pcElem
);

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] prgn

種類: SHORT*

crgn SHORT 値を含むバッファーを指します。この関数が戻ると、バッファーはソース PROPVARIANT 構造体から抽出された pcElem SHORT 要素で初期化されています。

[in] crgn

種類: ULONG

要素の prgn によって指されるバッファーのサイズ。

[out] pcElem

種類: ULONG*

この関数が戻るとき、には、ソース PROPVARIANT 構造体から抽出された Int16 要素の数が含まれます。

戻り値

種類: HRESULT

この関数は、これらの値のいずれかを返すことができます。

リターンコード	説明
S_OK	成功した場合はS_OK を返し、それ以外の場合はエラー値を返します。
TYPE_E_BUFFERTOOSMALL	ソース PROPVARIANT には crgn 値を超える値が含まれていました。 prgn が指すバッファー。
E_INVALIDARG	PROPVARIANT が適切な型ではありません。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが、固定数の要素を持つ Int16 ベクター値を保持する PROPVARIANT を想定している場所で使用されます。

ソース PROPVARIANT の型が VT_VECTOR の場合 |VT_I2またはVT_ARRAY |VT_I2、このヘルパー関数は最大 crgn Int16 値を抽出し、 prgn が指すバッファーに配置します。 PROPVARIANT に prgn バッファーに収まるより多くの要素が含まれている場合、この関数はエラーを返し、pcElem を 0 に設定します。

例

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid
SHORT rgShorts[4]; // The application is expecting propvar to hold 4 Int16s in a vector
ULONG cElems;
HRESULT hr = PropVariantToInt16Vector(propvar, rgShorts, ARRAYSIZE(rgShorts), &cElems);
if (SUCCEEDED(hr))
{
     if (cElems == ARRAYSIZE(rgShorts))
     {
         // The application got 4 Int16s which are now stored in rgShorts
     }
     else
     {
         // The application got cElems which are stored in the first cElems elements of rgShorts
     }
}

要件

要件	値
サポートされている最小のクライアント	WINDOWS XP と SP2、Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 SP1 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	propvarutil.h
Library	Propsys.lib
[DLL]	Propsys.dll (バージョン 6.0 以降)
再頒布可能パッケージ	Windows デスクトップ検索 (WDS) 3.0