CMC_X_COM_configuration

Platform SDK: MAPI

CMC_X_COM_configuration

A CMC_X_COM_configuration structure contains configuration data written by the cmc_query_configuration function for the CMC_X_COM_CONFIG_DATA data extension.

Quick Info

Header file:

XCMCEXT.H

typedef struct { 
     CMC_uint16          ver_spec; 
     CMC_uint16          ver_implem; 
     CMC_object_identifier     *character_set; 
     CMC_enum               line_term; 
     CMC_string          default_service; 
     CMC_string          default_user; 
     CMC_enum               req_password; 
     CMC_enum               req_service; 
     CMC_enum               req_user; 
     CMC_boolean          ui_avail; 
     CMC_boolean          sup_nomkmsgread; 
     CMC_boolean          sup_counted_str; 
} CMC_X_COM_configuration;

Members

ver_spec

A CMC specification version number.

ver_implem

A CMC version number multiplied by 100. For example, version 1.00 is represented as 100.

character_set

Pointer to a CMC_object_identifier structure.

line_term

Enumeration that indicates the type of line delimiter for the message text in a CMC_message. Possible values are:

CMC_LINE_TERM_CRLF: The line delimiter is a carriage return followed by a line feed.
CMC_LINE_TERM_LF: The line delimiter is a line feed.
CMC_LINE_TERM_CR: The line delimiter is a carriage return.

default_service

Pointer to a string identifying the default message service.

default_user

Pointer to a string identifying the default user name of the user accessing the CMC implementation. This default can be used when prompting the user for a user name.

req_password

Enumeration that indicates if a password is required to access the service. Possible values are:

CMC_REQUIRED_NO: No password is required.
CMC_REQUIRED_YES: A password is required.
CMC_REQUIRED_OPT: A password is optional.

req_service

Enumeration that indicates if the message service name is required for logon. Possible values are:

CMC_REQUIRED_NO: No service name is required.
CMC_REQUIRED_YES: A service name is required.
CMC_REQUIRED_OPT: A service name is optional.

req_user

Enumeration that indicates if the messaging user name is required for logon. Possible values are:

CMC_REQUIRED_NO: No user name is required.
CMC_REQUIRED_YES: A user name is required.
CMC_REQUIRED_OPT: A user name is optional.

ui_avail

Boolean value that is TRUE if the CMC implementation in use provides a user interface and FALSE otherwise.

sup_nomkmsgread

Boolean value that indicates whether the cmc_read function supports not marking messages as read. The value is TRUE if the cmc_read function supports the CMC_DO_NOT_MARK_AS_READ flag and FALSE otherwise.

sup_counted_str

Boolean value that indicates whether the cmc_logon function supports the use of the CMC_counted_string type. The value is TRUE if the cmc_logon function supports the CMC_COUNTED_STRING_TYPE flag and FALSE otherwise.

Remarks

The cmc_query_configuration function writes a value into the buffer pointed to by its reference parameter. That value is a copy of a particular member of the CMC implementation's CMC_X_COM_configuration structure, depending on the value the client application passes for the item parameter. For example, to see whether the CMC implementation defines its own user interface for logon and error resolution, the client application should use CMC_CONFIG_UI_AVAIL as the value of item. When cmc_query_configuration returns, the CMC_buffer pointed to by reference will contain TRUE or FALSE to indicate whether an interface is available. The client application must ensure that the reference parameter points to a buffer of sufficient size to hold the type of data that the item parameter specifies.