OutlookStartSession (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

See also

OutlookStartSession (Function)

In french: OutlookOuvreSession

Used to access the data handled by the Outlook messaging software (emails, contacts, groups of contacts, tasks, appointments and folders). This function is equivalent to EmailStartOutlookSession. To close the session, you must use CloseSession or EmailCloseSession.

Caution: This function cannot be used to access the data handled by the Outlook Express messaging software.

Note: When using OutlookStartSession, the current directory is automatically modified by Outlook.

Example

See additional examples

// Start the session
IF OutlookStartSession("MyProfile") <> 0 THEN
Info("Session started")
ELSE
Error(ErrorInfo())
END

Syntax

<Result> = OutlookStartSession(<Profile> [, <Opening Options>])

<Result>: Integer

Session identifier.
0 or False if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Profile>: Character string (with quotes)

Identifies the connection profile.
Versions 16 and later
The default profile is returned by OutlookDefaultProfile.
The list of available profiles is returned by OutlookListProfile.
New in version 16
The default profile is returned by OutlookDefaultProfile.
The list of available profiles is returned by OutlookListProfile.
The default profile is returned by OutlookDefaultProfile.
The list of available profiles is returned by OutlookListProfile.
If this parameter corresponds to an empty string (""):
if several profiles are defined on the current computer, OutlookStartSession displays a window containing all profiles among which the user can choose his own profile.
if a single profile is defined on the current computer, OutlookStartSession automatically selects this profile.
User account to use. If this parameter contains an empty string (""), the "ActiveSync" user account will be used.

<Opening Options>: Optional integer constant

Versions 18 and later
Mode for opening the Outlook session:
outlookAPTWithContact
(Default value) The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipant The AppointmentXXX functions will list the participants associated with the appointments in the following variables:
mAppointment.Participant
mAppointment.ParticipantCc
mAppointment.ParticipantBcc
See Appointment structure for more details.
New in version 18
Mode for opening the Outlook session:
outlookAPTWithContact
(Default value) The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipant The AppointmentXXX functions will list the participants associated with the appointments in the following variables:
mAppointment.Participant
mAppointment.ParticipantCc
mAppointment.ParticipantBcc
See Appointment structure for more details.
Mode for opening the Outlook session:
outlookAPTWithContact
(Default value) The AppointmentXXX functions will list the contacts associated with the appointments in the mAppointment.Participant variable (see Appointment structure).
outlookAPTWithParticipant The AppointmentXXX functions will list the participants associated with the appointments in the following variables:
mAppointment.Participant
mAppointment.ParticipantCc
mAppointment.ParticipantBcc
See Appointment structure for more details.

Remarks

Creating a profile

To start a new session with Outlook, a "profile" must be defined. This "profile" is defined in the configuration of the Internet connection with Outlook.

To create a profile:

Start Outlook.
In the "Choosing a profile" window, click [New].
Select the "Microsoft Exchange Server" service.
Give a name to the profile.
Enter the name of Microsoft Exchange server.

Current directory

Caution: OutlookStartSession modifies the path of the current directory (returned by fCurrentDir).

Component : wd240com.dll