JCL Help:MapiCheck

 JCL Help: MapiCheck Function

InternetandE-mail.MAPI

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Checks the MAPI result code.

Pascal

 function MapiCheck(const Res: DWORD; IgnoreUserAbort: Boolean = True): DWORD;

Parameters

Parameters	Description
const Res: DWORD	MAPI result code.
IgnoreUserAbort: Boolean = True	Set to True (default) to ignore MAPI_E_USER_ABORT, otherwise MAPI_E_USER_ABORT will be seen as an error.

Return Value

If MAPI result code is not an error the function returns the result code, otherwise an EJclMAPIError exception is raised.

Description

MapiCheck checks the MAPI result code, optionally ignoring user abort codes. If an error occurred, an exception is raised, otherwise the result code will be returned (which is either SUCCESS_SUCCESS or MAPI_E_USER_ABORT).

About

Unit

JclMapi

Donator

Petr Vones

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository