PropVariantToStringVectorAlloc 関数 (propvarutil.h)
PROPVARIANT 構造体から、新しく割り当てられたベクター内の新しく割り当てられた文字列にデータを抽出します。
構文
PSSTDAPI PropVariantToStringVectorAlloc(
[in] REFPROPVARIANT propvar,
[out] PWSTR **pprgsz,
[out] ULONG *pcElem
);
パラメーター
[in] propvar
型: REFPROPVARIANT
ソース PROPVARIANT 構造体への参照。
[out] pprgsz
種類: PWSTR**
この関数が戻るとき、 には、ソース PROPVARIANT 構造体から抽出された文字列のベクターへのポインターが含まれます。
[out] pcElem
種類: ULONG*
この関数が戻るとき、 には、ソース PROPVARIANT 構造体から抽出された文字列要素の数が含まれます。
戻り値
種類: HRESULT
この関数は、これらの値のいずれかを返すことができます。
| リターン コード | 説明 |
|---|---|
|
成功した場合 はS_OK を返し、それ以外の場合はエラー値を返します。 |
|
PROPVARIANT が適切な型ではありません。 |
解説
このヘルパー関数は、呼び出し元アプリケーションが PROPVARIANT が文字列値のベクトルを保持することを想定している場所で使用されます。
このヘルパー関数は、次のPROPVARIANT 型に 対して機能します。
- VT_VECTOR |VT_LPWSTR
- VT_VECTOR |Vt_bstr
- VT_ARRAY | VT_BSTR
ソース PROPVARIANT の BSTR が NULL の場合、この関数は"" を含む新しく割り当てられた文字列を出力ベクトルに配置します。
例
より大きなプログラムの一部として含める次の例では、 PropVariantToStringVectorAlloc を使用して PROPVARIANT の文字列ベクター値にアクセスする方法を示します。
// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_Keywords, &propvar);
if (SUCCEEDED(hr))
{
// PKEY_Keywords is expected to produce a VT_VECTOR | VT_LPWSTR, or VT_EMPTY
// PropVariantToStringVectorAlloc will return an error for VT_EMPTY
LPWSTR *prgKeywords;
ULONG cElem;
hr = PropVariantToStringVectorAlloc (propvar, &prgKeywords, &cElem);
if (SUCCEEDED(hr))
{
// prgKeywords contains cElem strings
for (ULONG i = 0; i < cElem; i++)
{
CoTaskMemFree(prgKeywords[i]);
}
CoTaskMemFree(prgKeywords);
}
else
{
// propvar either is VT_EMPTY, or contains something other than a vector of strings
}
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 |