WsGetHeapProperty, fonction (webservices.h)

Récupère une propriété particulière d’un tas spécifié.

Syntaxe

HRESULT WsGetHeapProperty(
  [in]           WS_HEAP             *heap,
  [in]           WS_HEAP_PROPERTY_ID id,
                 void                *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Paramètres

[in] heap

Pointeur vers l’objet Tas vers lequel contient les données de propriété souhaitées.

[in] id

Il s’agit d’un énumérateur WS_HEAP_PROPERTY_ID qui identifie la propriété souhaitée.

value

Référence à la valeur de la propriété récupérée. Le pointeur doit avoir un alignement compatible avec le type de la propriété.

[in] valueSize

Taille de mémoire tampon allouée par l’appelant pour la valeur de propriété récupérée.

[in, optional] error

Pointeur vers un objet WS_ERROR où des informations supplémentaires sur l’erreur doivent être stockées en cas d’échec de la fonction.

Valeur retournée

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Spécifications