IMAPIFormInfo::SaveForm

The IMAPIFormInfo::SaveForm method saves a description of a particular form in a configuration file.

Quick Info

See IMAPIFormInfo : IMAPIProp.

HRESULT SaveForm(
  LPCTSTR szFileName  
);
 

Parameters

szFileName
[in] String naming the form's description message file where its description is saved. This filename must have the .FDM extension.

Return Values

S_OK
The call succeeded and has returned the expected value or values.
MAPI_E_EXTENDED_ERROR
The configuration file could not be written. To get the MAPIERROR structure associated with the error, call the IMAPIProp::GetLastError method.
MAPI_E_NO_SUPPORT
SaveForm was probably called to save a form in the local form container. SaveForm is not supported on the local form container.

Remarks

Client applications call the IMAPIFormInfo::SaveForm method to save a description of the current form in the file with the given filename. SaveForm creates a configuration file.

Notes to Callers

Forms can be reinstalled by being selected from a list of form descriptor messages in a dialog box displayed by form library providers. The recommended extension for form descriptor messages is .FDM.

Call IMAPIProp::GetLastError if SaveForm returns MAPI_E_EXTENDED_ERROR, and check the returned MAPIERROR structure to determine the condition causing the error.