ContactRead (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Current contact
Contact structure
Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ContactRead (Function)

In french: ContactLit

Reads a contact found in:

the address book of a Lotus Notes or Outlook messaging.
Caution: This function cannot be used to read a 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), ContactRead 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), ContactRead 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), ContactRead is available for backward compatibility. This function is not recommended if you are using Contact variables.

To be read, this contact must have been:

read (ContactLast, ContactPrevious, ContactFirst or ContactNext),
added (ContactAdd),
modified (ContactModify),
sought (ContactSearch).

ContactRead does not position on the contact read.

When reading a contact, the data of this contact is updated in 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 = EmailStartNotesSession("Password", "MarsServer", "email/julia.nsf", ...
"C:\Lotus Notes\julia.id")
// Read the first contact
ContactFirst(SessionID)
...
// Read this same contact again
ContactRead(SessionID, mContact.ID)

Syntax

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

<Result> = ContactRead(<Session identifier> , <Contact identifier>)

<Result>: Boolean

True if the contact was read,
False otherwise. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Session identifier>: Integer

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

<Contact identifier>: Character string

Identifier of the contact to read. This identifier is found in the mContact.ID variable.

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 a contact found in the list of contacts on the device (Android, iPhone or iPad, Universal Windows) Hide the details

<Result> = ContactRead(<Type of contact> , <Contact identifier>)

<Result>: Boolean

True if the contact was read,
False otherwise. To find out the error details, use ErrorInfo with the errMessage constant.

<Type of contact>: Integer constant

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

<Contact identifier>: Character string

Identifier of the contact to read. This identifier is found in the mContact.ID variable.

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, ...).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, ...).
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, ...).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, ...).
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, ...).
mContact.HomePhone
mContact.HomeFax
mContact.MobilePhone
mContact.Company
mContact.Department
mContact.OfficeAddress
Contains the full business address (Street, city, zip, ...).
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 an application feature in the wizard for generating the application.

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 an application feature in the wizard for generating the application.

Required feature: Contacts

This feature allows the applications to access the contacts.

Required application feature

The use of this function triggers the declaration of an application feature in the wizard for generating the application.

Required feature: Contacts

This feature allows the applications to access the contacts.

Component : wd250com.dll