Fonction PropVariantToBuffer (propvarutil.h)

Article
03/01/2024

Extrait la valeur de mémoire tampon d’une structure PROPVARIANT de type VT_VECTOR | VT_UI1 ou VT_ARRRAY | VT_UI1.

Syntaxe

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

Paramètres

[in] propvar

Type : REFPROPVARIANT

Structure PROPVARIANT source.

[out] pv

Type : VOID*

Pointeur vers une mémoire tampon de longueur cb octets. Lorsque cette fonction retourne, contient les premiers octets cb de la valeur de mémoire tampon extraite.

[in] cb

Type : UINT

Longueur de la mémoire tampon, en octets.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	En cas de réussite, ou une valeur d’erreur dans le cas contraire.
E_INVALIDARG	PROPVARIANT était du type incorrect.
E_FAIL	La valeurPROPVARIANT avait moins d’octets cb .

Remarques

Cette fonction est utilisée dans les endroits où l’application appelante s’attend à ce qu’unPROPVARIANT contienne une valeur de mémoire tampon. L’application appelante doit case activée que la valeur a la longueur attendue avant d’appeler cette fonction.

Si la source PROPVARIANT a le type VT_VECTOR | VT_UI1 ou VT_ARRAY | VT_UI1, cette fonction extrait les premiers octets cb de la valeur et les place dans la mémoire tampon pointée par pv. Si la valeur a moins d’octets cb , PropVariantToBuffer échoue et la mémoire tampon n’est pas modifiée. Si la valeur a plus d’octets cb , PropVariantToBuffer réussit et tronque la valeur.

Exemples

L’exemple suivant, à inclure dans un programme plus grand, montre comment utiliser PropVariantToBuffer pour accéder à une structure qui a été stockée dans un 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);
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	propvarutil.h
Bibliothèque	Propsys.lib
DLL	Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0

Voir aussi

InitPropVariantFromBuffer

VariantToBuffer

Partager via