Share this page

# mapi_logon

MS Exchange Server Functions (mapi)

Logs on to MS Exchange.

    int mapi_logon( char *transaction, char *profilename, char *profilepass, LAST );

transaction | A transaction name for this step in quotes. To instruct VuGen not to create a transaction for this step, use a null string, "".
profilename | The profile's user name in quotes. Optional.
profilepass | A profile's password in quotes. Optional.
LAST | A marker indicating the end of the argument list.

The mapi_logon function logs on to an MS Exchange server using simple MAPI, the MS Exchange protocol.

This function is for use with global sessions. For multiple sessions, use the mapi_logon_ex function, which allows you to specify a session identifier.

The function logs on to the MS Exchange Server using the default account's user name and password, and no error is issued, under the following circumstances:

- Either profilename or profilepass is not specified.

- Both profilename and profilepass are not specified.

- No profile exists on the mail client for the profilename and profilepass combination.

## Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

## Parameterization

All arguments of this function of the type char, can be parameterized with standard parameterization.

## Example

In the following example, the mapi_logon function logs on to MS Exchange.

    mapi_logon("Logon",

                "John Smith",
                "Tiger",
                LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: