IMAPIFormInfo::CalcVerbSet

Applies to: Outlook 2013 | Outlook 2016

Returns a pointer to the complete set of verbs that a form uses.

HRESULT CalcVerbSet(
  ULONG ulFlags,
  LPMAPIVERBARRAY FAR * ppMAPIVerbArray
);

Parameters

ulFlags

[in] A bitmask of flags that controls the type of strings returned. 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.

ppMAPIVerbArray

[out] A pointer to a pointer to the returned SMAPIVerbArray structure that contains the form's verbs.

Return value

S_OK

The call succeeded and has 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.

Remarks

Client applications call the IMAPIFormInfo::CalcVerbSet method to obtain a pointer to the set of verbs used by a form. In the SMAPIVerbArray structure returned in the ppMAPIVerbArray parameter, the verbs are returned in order of index number; each verb's index is found in its lVerb member. Client applications can use the verb array to dynamically build menus, hide or show buttons, and so on.

MFCMAPI reference

For MFCMAPI sample code, see the following table.

See also

SMAPIVerbArray

IMAPIFormInfo : IMAPIProp

MFCMAPI as a Code Sample