Share via


IMAPIFormInfo::SaveForm

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Saves a description of a particular form in a configuration file.

HRESULT SaveForm(
  LPCSTR szFileName
);

Parameters

  • szFileName
    [in] A string that names the form's description message file where its description is saved. This file name must have the .fdm extension.

Return Value

  • 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 that is 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 that has the given file name. SaveForm creates a configuration file.

Notes to Callers

You can reinstall forms by selecting them from a list of form descriptor messages in a dialog box that form library providers display. The recommended extension for form descriptor messages is .fdm.

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

See Also

Reference

IMAPIProp::GetLastError

MAPIERROR

IMAPIFormInfo : IMAPIProp