IMAPIFormMgr::SelectMultipleForms

The IMAPIFormMgr::SelectMultipleForms method presents a dialog box that enables the user to select multiple forms and returns an array of form information objects describing those forms.

Quick Info

See IMAPIFormMgr : IUnknown.

HRESULT SelectMultipleForms(
  ULONG ulUIParam,                          
  ULONG ulFlags,                            
  LPCTSTR pszTitle,                         
  LPMAPIFOLDER pfld,                        
  LPMAPIFORMINFOARRAY pfrminfoarray,        
  LPMAPIFORMINFOARRAY FAR * ppfrminfoarray  
)
 

Parameters

ulUIParam

[in] Handle of the parent window for the dialog box displayed.

ulFlags

[in] Bitmask of flags that controls the type of the passed-in strings. The following flag can be set:

MAPI_UNICODE

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

pszTitle

[in] Pointer to a string containing the caption of the dialog box. If the pszTitle parameter is NULL, the form library provider that provides the forms supplies a default caption.

pfld

[in] Pointer to the folder from which to select the forms. If the pfld parameter is NULL, the forms are selected from the local, personal, or organization form container.

pfrminfoarray

[in] Pointer to an array of form information objects that are preselected for the user.

ppfrminfoarray

[out] Pointer to a pointer to the returned array of form information objects.

Return Values

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 only supports Unicode.

MAPI_E_USER_CANCEL

The user canceled the operation, typically by clicking the Cancel button in the dialog box.

Remarks

Form viewers call the IMAPIFormMgr::SelectMultipleForms method to first present a dialog box that enables the user to select multiple forms and then to retrieve an array of form information objects describing the selected forms. The SelectMultipleForms dialog box displays all forms, whether or not they are hidden — that is, whether or not their hidden properties are clear.

Notes to Implementers

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