PropVariantToUInt16VectorAlloc 関数 (propvarutil.h)

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

PROPVARIANT 構造体から、新しく割り当てられた符号なしショート ベクターにデータを抽出します。

構文

PSSTDAPI PropVariantToUInt16VectorAlloc(
  [in]  REFPROPVARIANT propvar,
  [out] USHORT         **pprgn,
  [out] ULONG          *pcElem
);

パラメーター

[in] propvar

型: REFPROPVARIANT

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

[out] pprgn

種類: USHORT**

この関数が戻るとき、には、ソース PROPVARIANT 構造体から抽出された符号なし短い値のベクターへのポインターが含まれます。

[out] pcElem

種類: ULONG*

この関数が戻るとき、には、ソース PROPVARIANT 構造体から抽出された符号なし短い値の数が含まれます。

戻り値

種類: HRESULT

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

リターンコード	説明
S_OK	成功した場合はS_OK を返し、それ以外の場合はエラー値を返します
E_INVALIDARG	PROPVARIANT が適切な型ではありません。

注釈

このヘルパー関数は、呼び出し元のアプリケーションが PROPVARIANT が 符号なし短い 値のベクトルを保持することを想定している場所で使用されます。

ソース PROPVARIANT の型が VT_UI2 または VT_ARRAY | VT_UI2VT_VECTOR | 場合、この関数は符号なし短い値のベクトルを新しく割り当てられたベクターに抽出します。呼び出し元のアプリケーションは、 CoTaskMemFree を使用して 、pprgn が指すベクトルが不要になったときに解放する役割を担います。

例

次の例は、より大きなプログラムの一部として含まれるように、PropVariantToUInt16VectorAlloc を使用して PROPVARIANT の符号なし短いベクトル値にアクセスする方法を示しています。

// PROPVARIANT propvar;
// Assume the variable propvar is initialized and valid. The application is expecting propvar to contain a vector of <dtype rid="ushort"/> values.
USHORT *prgShorts;
ULONG cElems;
HRESULT hr = PropVariantToUInt16VectorAlloc(propvar, & prgShorts, &cElems);
if (SUCCEEDED(hr))
{
     // prgShorts now points to a vector of cElems USHORTs.
     CoTaskMemFree(prgShorts);
}

要件

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