ContactFirst (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Current contact
Contact structure
Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ContactFirst (Function)

In french: ContactPremier

Reads the first contact found in:

the address book of a Lotus Notes or Outlook messaging.
Caution: This function cannot be used to read the first contact found in the address book of an Outlook Express messaging.
Versions 16 and later
the list of contacts on the device (Android, iPhone or iPad, Universal Windows).
Warning
From version 17 (69), ContactFirst is available for backward compatibility. This function is not recommended if you are using Contact variables.

New in version 16
the list of contacts on the device (Android, iPhone or iPad, Universal Windows).
Warning
From version 17 (69), ContactFirst is available for backward compatibility. This function is not recommended if you are using Contact variables.

the list of contacts on the device (Android, iPhone or iPad, Universal Windows).
Warning
From version 17 (69), ContactFirst is available for backward compatibility. This function is not recommended if you are using Contact variables.

When reading a contact, the data of this contact is updated in the Contact structure. To retrieve the data of the current contact, all you have to do is retrieve the values from the Contact structure.

Versions 16 and later

This function is now available for Android applications.

New in version 16

This function is now available for Android applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

This function is now available in Android Widget mode.

This function is now available for iPhone/iPad applications.

Versions 22 and later

This function is now available in Universal Windows 10 App mode.

New in version 22

This function is now available in Universal Windows 10 App mode.

Example

// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartSession("Password", "MarsServer", "email/julia.nsf", ...
"C:\Lotus Notes\julia.id")
// Read the first contact
ContactFirst(SessionID)
// Add the contacts found into a List Box control
WHILE mContact.Out = False
ListAdd(LIST_ContactList, mContact.Name + TAB + mContact.FirstName)
ContactNext(SessionID)
END

// Start an Outlook session
SessionID is int
SessionID = OutlookStartSession("Profile")
// Read the first contact
ContactFirst(SessionID)
// Add the contacts found into a List Box control
WHILE mContact.Out = False
ListAdd(LIST_ContactList, mContact.Name + TAB + mContact.FirstName)
ContactNext(SessionID)
END

Syntax

Reading the first contact in the Lotus Notes or Outlook messaging Hide the details

<Result> = ContactFirst(<Session identifier>)

<Result>: Boolean

True if the first contact was read,
False otherwise. To find out the name of the error, use the function ErrorInfo with the constant errMessage.

<Session identifier>: Integer

Identifier of session to use. This identifier is returned by one of the following functions: EmailStartNotesSession, EmailStartOutlookSession, NotesOpenDatabase or OutlookStartSession.

Versions 16 and later

Warning
From version 17 (69), this syntax is kept for backward compatibility.

New in version 16

Warning
From version 17 (69), this syntax is kept for backward compatibility.

Reading the first contact found in the list of contacts on the device (Android, iPhone or iPad, Universal Windows) Hide the details

<Result> = ContactFirst(<Type of contact> [, <Type of information>])

<Result>: Boolean

True if the first contact was read,
False otherwise. To find out the name of the error, use the function ErrorInfo with the constant errMessage.

<Type of contact>: Integer constant

Type of contact to use. By default, this parameter corresponds to the contactPhone constant.

<Type of information>: Integer constant (or combination of constants)

Specifies the information about the contact to fill in the Contact structure when reading the contact. For performance reasons, we recommend that you only ask for the information really required when browsing the contacts. The available constants are as follows:
contactInfoAddress Street address of the contact (business and home)
contactInfoEmail Email addresses of the contact
contactInfoGeneral Name of the contacts and notes
contactInfoCompany Company and department of the contact
contactInfoPhone Phone number of the contact: desk, mobile, business and home fax
contactInfoAll
(Default value) All the available information about the contact.

If this parameter is not specified, the Contact structure will be filled with the available information about the contact.
This parameter is not supported.

Remarks

Current contact

The mContact.Out variable is used to find out whether a current contact exists.

Versions 16 and later

Contact structure

Only the following members of the Contact structure will be taken into account when reading a contact:

mContact.Out
mContact.Name
Contains the display name of the contact (for example: Paul Smith).
mContact.Notes
mContact.HomeAddress
Contains the full home address (Street, city, zip, etc.).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, etc.).
mContact.OfficePhone
mContact.OfficeFax
mContact.OfficeMobilePhone
mContact.OfficePager
mContact.Email
mContact.NbEmail
mContact.ID

New in version 16

Contact structure

Only the following members of the Contact structure will be taken into account when reading a contact:

mContact.Out
mContact.Name
Contains the display name of the contact (for example: Paul Smith).
mContact.Notes
mContact.HomeAddress
Contains the full home address (Street, city, zip, etc.).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, etc.).
mContact.OfficePhone
mContact.OfficeFax
mContact.OfficeMobilePhone
mContact.OfficePager
mContact.Email
mContact.NbEmail
mContact.ID

Contact structure

Only the following members of the Contact structure will be taken into account when reading a contact:

mContact.Out
mContact.Name
Contains the display name of the contact (for example: Paul Smith).
mContact.Notes
mContact.HomeAddress
Contains the full home address (Street, city, zip, etc.).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, etc.).
mContact.OfficePhone
mContact.OfficeFax
mContact.OfficeMobilePhone
mContact.OfficePager
mContact.Email
mContact.NbEmail
mContact.ID

Versions 22 and later

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Contacts

This feature allows the applications to access the contacts.

New in version 22

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Contacts

This feature allows the applications to access the contacts.

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Contacts

This feature allows the applications to access the contacts.

Component: wd260com.dll