IMAPIFormMgr::SelectForm

The IMAPIFormMgr::SelectForm method presents a dialog box that enables the user to select a form and returns a form information object describing that form.

Quick Info

See IMAPIFormMgr : IUnknown.

HRESULT SelectForm(
  ULONG ulUIParam,                        
  ULONG ulFlags,                          
  LPCTSTR pszTitle,                       
  LPMAPIFOLDER pfld,                      
  LPMAPIFORMINFO FAR * ppfrminfoReturned  
);
 

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 supplies a default caption.

pfld

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

ppfrminfoReturned

[out] Pointer to a pointer to the returned form information object.

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::SelectForm method to first present a dialog box that enables the user to select a form and then to retrieve a form information object describing the selected form. The dialog box constrains the user to select a single form.

Notes to Callers

The SelectForm dialog box only displays forms that are not hidden — that is, that have their hidden properties clear. 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.