HrGetOneProp
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Retrieves the value of a single property from a property interface, that is, an interface derived from IMAPIProp.
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 Value
- 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.
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
MAPIFunctions.cpp |
GetMAPIObjectType |
MFCMAPI uses the HrGetOneProp method to retrieve the type of an object. |