PropVariantToBuffer 関数 (propvarutil.h)

VT_VECTOR 型の PROPVARIANT 構造体からバッファー値を抽出します。 |VT_UI1またはVT_ARRRAY |VT_UI1。

構文

PSSTDAPI PropVariantToBuffer(
  [in]  REFPROPVARIANT propvar,
  [out] void           *pv,
  [in]  UINT           cb
);

パラメーター

[in] propvar

型: REFPROPVARIANT

ソース PROPVARIANT 構造体。

[out] pv

型: VOID*

長 さ cb バイトのバッファーへのポインター。 この関数が戻るときに、抽出されたバッファー値の最初の cb バイトが格納されます。

[in] cb

型: UINT

バッファーの長さ (バイト単位)。

戻り値

型: HRESULT

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

リターン コード	説明
S_OK	成功した場合は 。それ以外の場合はエラー値。
E_INVALIDARG	PROPVARIANT の型が正しくありません。
E_FAIL	PROPVARIANT 値のバイト数が cb バイト未満でした。

注釈

この関数は、呼び出し元のアプリケーションがPROPVARIANT がバッファー値を保持することを想定している場所で使用されます。 呼び出し元のアプリケーションは、この関数を呼び出す前に、値の長さが予想されることをチェックする必要があります。

ソース PROPVARIANT の型が VT_VECTOR の場合 |VT_UI1またはVT_ARRAY |VT_UI1、この関数は値から最初の cb バイトを抽出し、 pv が指すバッファーに格納します。 値が cb バイト未満の場合、 PropVariantToBuffer は失敗し、バッファーは変更されません。 値が cb バイトを超える場合、 PropVariantToBuffer は成功し、値を切り捨てます。

例

次の例は、より大きなプログラムの一部として含まれるように、PropVariantToBuffer を使用して PROPVARIANT に格納されている構造体にアクセスする方法を示しています。

// IPropertyStore *ppropstore;
// Assume variable ppropstore is initialized and valid
PROPVARIANT propvar = {0};
HRESULT hr = ppropstore->GetValue(PKEY_FindData, &propvar);

if (SUCCEEDED(hr))
{
    // PKEY_FindData is expected to produce a VT_VECTOR | VT_UI1 with sizeof(WIN32_FIND_DATAW) bytes
    // We need to verify that the value length is acceptable before calling PropVariantToBuffer
    hr = E_UNEXPECTED;
    
    if (PropVariantGetElementCount(propvar) == sizeof(WIN32_FIND_DATAW))
    {
        WIN32_FIND_DATAW wfd;
        hr = PropVariantToBuffer(propvar, &wfd, sizeof(wfd));
        
        if (SUCCEEDED(hr))
        {
            // wfd is now initialized
        }
    }
    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

こちらもご覧ください

InitPropVariantFromBuffer

VariantToBuffer