Export (0) Print
Expand All

IMAPIFormMgr::CalcFormPropSet

Published: July 16, 2012

Returns an array of the properties that a group of forms uses.

HRESULT CalcFormPropSet(
  LPSMAPIFORMINFOARRAY pfrminfoarray,
  ULONG ulFlags,
  LPMAPIFORMPROPARRAY FAR * ppResults
);

pfrminfoarray

[in] A pointer to an array of form information objects that identify the forms for which to return properties.

ulFlags

[in] A bitmask of flags that controls how the property array in the ppResults parameter is returned. The following flags can be set:

FORMPROPSET_INTERSECTION

The returned array contains the intersection of the form's properties.

FORMPROPSET_UNION

The returned array contains the union of the form's properties.

MAPI_UNICODE

The strings returned in the array are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.

ppResults

[out] A pointer to a pointer to the returned SMAPIFormPropArray structure, which contains the properties that the forms use.

S_OK

The call succeeded and returned the expected value or values.

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.

Form viewers call the IMAPIFormMgr::CalcFormPropSet method to obtain an array of the properties that a group of forms uses. CalcFormPropSet takes either an intersection or a union of these forms' property sets, depending on the flag set in the ulFlags parameter, and it returns an SMAPIFormPropArray structure that contains the resulting group of properties.

If a form viewer passes the MAPI_UNICODE flag in the ulFlags parameter, all strings should be returned as Unicode strings. Form library providers that do not support Unicode strings should return MAPI_E_BAD_CHARWIDTH if MAPI_UNICODE is passed.

Community Additions

ADD
Show:
© 2014 Microsoft