IMAPIProp::GetPropList
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.
Returns property tags for all properties.
HRESULT GetPropList(
ULONG ulFlags,
LPSPropTagArray FAR * lppPropTagArray
);
Parameters
ulFlags
[in] A bitmask of flags that controls the format for the strings in the returned property tags. The following flag can be set:- MAPI_UNICODE
The returned strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.
- MAPI_UNICODE
lppPropTagArray
[out] A pointer to a pointer to the property tag array that contains tags for all of the object's properties.
Return Value
S_OK
All of the property tags were returned successfully.MAPI_E_BAD_CHARWIDTH
Either the MAPI_UNICODE flag was set and the implementation does not support Unicode, or MAPI_UNICODE was not set and the implementation supports only Unicode.
Remarks
The IMAPIProp::GetPropList method retrieves the property tag for each property currently supported by an object. If the object does not currently support any properties, GetPropList returns a property tag array with the cValues member set to 0.
The scope of properties returned by GetPropList varies from provider to provider. Some service providers exclude those properties for which the caller does not have access. All providers return properties of type PT_OBJECT.
If the object does not support Unicode, GetPropList returns MAPI_E_BAD_CHARWIDTH, even if there are no string properties defined for the object.
Notes to Implementers
Remote transport providers implement GetPropList exactly as specified here. There are no special concerns. Your implementation should, of course, return the same list of properties as supported by the IMAPIProp::GetProps method.
Notes to Callers
Call the MAPIFreeBuffer function to free the property tag array pointed to by lppPropTagArray .
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
MAPIFunctions.cpp |
GetPropsNULL |
MFCMAPI uses the IMAPIProp::GetPropList method to get a property list to pass to GetProps. |