Share via

HrSetOneProp

  • Article

4/8/2010

The HrGetOneProp function sets or modifies 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 HrSetOneProp(
  LPMAPIPROP lpMapiProp
  LPSPropValue lpProp
);

Parameters

  • lpMapiProp
    [in] Reference to the object on which the property value is to be set or modified.
  • lpProp
    [in] Pointer to the SPropValue structure which defines the property value to set or modify.

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::SetProps method, the HrSetOneProp function never returns a warning. Because it sets only one property, it either succeeds or fails. For setting or changing multiple properties, use IMAPIProp::SetProps.

You can retrieve a single property with the HrGetOneProp 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
HrGetOneProp
IMAPIProp::SetProps

Other Resources

Messaging