IMAPIFormMgr::PrepareForm

The IMAPIFormMgr::PrepareForm method downloads a form for launching.

Quick Info

HRESULT PrepareForm(
  ULONG ulUIParam,          
  ULONG ulFlags,            
  LPMAPIFORMINFO pfrmiInfo  
);

Parameters

ulUIParam

[in] Handle of the parent window for the progress indicator displayed while the form is downloaded. The ulUIParam parameter is ignored unless the MAPI_DIALOG flag is set in the ulFlags parameter.

ulFlags

[in] Bitmask of flags that controls how the form is downloaded. The following flag can be set:

MAPI_DIALOG: Displays a user interface to provide status or prompt the user for additional information. If this flag is not set, no user interface is displayed.

pfrmiInfo

[in] Pointer to a form information object for the form to be downloaded.

Return Values

S_OK: The call succeeded and has returned the expected value or values.

Remarks

Form viewers call the IMAPIFormMgr::PrepareForm method to download a form from a form container for launching. Most form viewers do not need to call PrepareForm because both the IMAPIFormMgr::CreateForm and IMAPIFormMgr::LoadForm methods call PrepareForm if necessary.

PrepareForm can be used to obtain the dynamic-link libraries (DLLs) and other files associated with a form in order to modify them. If the modified form is loaded back into its form container, it must be reinstalled.