ContactRead (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

ContactRead (Function)

In french: ContactLit

Not available

Reads a contact found in:

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:

ContactRead does not set the position on the contact read.

When reading a contact, the data of this contact is updated in the Contact structure.

Example

Syntax

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

Reading a contact from the contact list of the device (before Android 2.0, iPhone, iPad and Universal Windows) Hide the details

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

<Result>: Boolean

True if the contact was read,
False otherwise. To get more details on the error, 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.

Syntax that is using the Contact structure (before Android 2.0)

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

Required application feature

When this function is used, an application feature is declared in the application generation wizard.

Required feature: Contacts

This feature allows the applications to access the contacts.

Component: wd270com.dll