Comment on this topic

Documentation Comments

Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.

Reality V15.2 Online Documentation (MoTW) Revision 3

EM_DEFINE_CONFIG Function (DataBasic Email API) (em_define_config.htm)

To

Reality

Version

Topic

Submitted by

Company

Location

Email address

Comment

 

 

EM_DEFINE_CONFIG Function

Purpose

Optionally specifies an email configuration file that contains any predefined configuration items. This can be unique to the current account, or a Q-pointer to allow for a global configuration.

The default email configuration file (which is assumed if no alternative file is specified by this function) is EM_CONFIG in the account from which the DataBasic Email API is being called.

Returns TRUE or FALSE.

Syntax

EM_DEFINE_CONFIG(filename)

Syntax elements

filenameThe name of the file containing any predefined configuration items.

Returns

EM_DEFINE_CONFIG returns TRUE if successful or FALSE if unsuccessful. If FALSE, the details of the failure can be found by inspecting the error number held in the common variable EM_ERROR_DETAILS.

Comments

You must include the item #EM_INCLUDES in all programs that use the Email API functions; for example, you could add the line

INCLUDE #EM_INCLUDES FROM /SYSFILES/SYS.BASLIB

at the start of the program, or create an item to be automatically included that contains this line.

RealityV15.2Revision 3Comment on this topic