Platform SDK: MAPI

HrGetOneProp

The HrGetOneProp function retrieves the value of a single property from a property interface, that is, an interface derived from IMAPIProp.

Note  This function may not be supported in future versions of MAPI.

Quick Info

Header file: MAPIUTIL.H
Implemented by: MAPI
Called by: Client applications and service providers

HrGetOneProp(
  LPMAPIPROP pmp,            
  ULONG ulPropTag,           
  LPSPropValue FAR * ppprop  
);
 

Parameters

pmp
[in] Pointer to the IMAPIProp interface from which the property value is to be retrieved.
ulPropTag
[in] Property tag of the property to be retrieved.
ppprop
[out] Pointer to a pointer to the returned SPropValue structure defining the retrieved property value.

Return Values

MAPI_E_NOT_FOUND
The requested property is not available from the specified interface.

Remarks

Unlike the IMAPIProp::GetProps method, the HrGetOneProp function never returns any warning. Because it retrieves only one property, it simply either succeeds or fails. For retrieving multiple properties, GetProps is faster.

You can set or change a single property with the HrSetOneProp function.

See Also

Properties Functions