Share via

HrGetOneProp

  • Article

4/8/2010

The HrGetOneProp function retrieves the value of a single property from an object that support properties, such as an IAttach, a IMAPIContainer, a IMAPIFolder, a IMessage, or a IMsgStore.

Note

This function may be deprecated in future versions of MAPI

Syntax

HRESULT HrGetOneProp(
  LPMAPIPROP lpMapiProp
  ULONG ulPropTag
  LPSPropValue FAR* lppProp
);

Parameters

  • lpMapiProp
    [in] Reference to the object from which the property value is to be retrieved—which implements the IMAPIProp interface.
  • ulPropTag
    [in] Property tag of the property to be retrieved.
  • lppProp
    [out] Pointer to a pointer to the returned SPropValue structure defining the retrieved property value.

Property Value/Return Value

This function returns an appropriate HRESULT value, such as the following:

  • S_OK
    The function successfully returned the value of a single property.
  • MAPI_E_NOT_FOUND
    The requested property cannot be found on the target object.

Remarks

Unlike the IMAPIProp::GetProps method, HrGetOneProp never returns a warning. Because it retrieves only one property, it either succeeds or fails. For retrieving multiple properties, use IMAPIProp::GetProps.

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

Requirements

Header mapiutil.h
Library cemapi.lib
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

MAPI Functions
MAPI Properties
HrSetOneProp
IMAPIProp::SetProps

Other Resources

Messaging