ContactSearch (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ContactSearch (Function)

In french: ContactCherche

Finds a contact:

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

New in version 16
in the list of contacts on the device (Android, iPhone or iPad, Universal Windows).
Warning
From version 17 (69), ContactSearch is available for backward compatibility. This function is not recommended if you are using Contact variables. In this case, we recommend that you use ContactList to find contacts.

in the list of contacts on the device (Android, iPhone or iPad, Universal Windows).
Warning
From version 17 (69), ContactSearch is available for backward compatibility. This function is not recommended if you are using Contact variables. In this case, we recommend that you use ContactList to find contacts.

ContactSearch does not set the position on the desired contact.

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")
...
// Find the contacts for the company named "Tames"
IF ContactSearch(SessionID, "Tames", mContactCompany) = True THEN
// Add the contacts found into a List Box control
WHILE mContact.Out = False
ListAdd(LIST_ContactList, mContact.Name + TAB + mContact.FirstName)
ContactNext(SessionID)
END
ELSE
Info("No contact was found")
END

// Find a name in the directory of contacts
// For example, find all the contacts containing "Vince"
// (the sought contact is handled by the mContact structure)
IF ContactSearch(contactPhone, "Vince", mContactLastName, True) = True THEN
// Add the contacts found in an edit control
WHILE mContact.Out = False
EDT_Text += mContact.Name + " - " + mContact.Company + ", "
ContactNext(contactPhone)
END
ELSE
EDT_Text = "No contact was found"
END

Syntax

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

<Result> = ContactSearch(<Session identifier> , <Sought value 1> , <Type of value 1> [, <Sought value 2> [, <Type of value 2>]])

<Result>: Boolean

True if one or more contacts correspond to the search,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Session identifier>: Integer

Session ID to be used. This identifier is returned by EmailStartNotesSession, EmailStartOutlookSession, NotesOpenDatabase or OutlookStartSession.

<Sought value 1>: Type of sought value

First value to find.

<Type of value 1>: Integer constant

Type of first value to find:
mContactCompany Search performed in the companies of contacts
mContactEmail Search performed in the emails of contacts
mContactFirstName Search performed in the first names of contacts
mContactLastName Search performed in the last names of contacts

<Sought value 2>: Type of sought value, optional

Second value to find. If this parameter and <Type of value 2> are not specified, the contact is sought according to <Sought value 1>.

<Type of value 2>: Optional Integer constant

Type of the second value to find:
mContactCompany Search performed in the companies of contacts
mContactEmail Search performed in the emails of contacts
mContactFirstName Search performed in the first names of contacts
mContactLastName Search performed in the last names of contacts
If this parameter and <Sought value 2> are not specified, the contact is sought according to <Sought value 1>.

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.

Finding a contact in the list of contacts on the device (Android, iPhone, iPad, Universal Windows) Hide the details

<Result> = ContactSearch(<Type of contact> , <Sought value 1> , <Type of value 1> [, <Sought value 2> [, <Type of value 2>]] [, <Type of search>])

<Result>: Boolean

True if one or more contacts correspond to the search,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Type of contact>: Integer constant

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

<Sought value 1>: Type of sought value

First value to find.

<Type of value 1>: Integer constant

Type of first value to find:
mContactCompany Search performed in the companies of contacts.
mContactEmail Search performed in the emails of contacts.
mContactFirstName Search performed in the display names of contacts.
mContactLastName Search performed in the display names of contacts.

<Sought value 2>: Type of sought value, optional

Second value to find. If this parameter and <Type of value 2> are not specified, the contact is sought according to <Sought value 1>.
This parameter is not available. The search cannot be performed on a second value.

<Type of value 2>: Optional Integer constant

Type of the second value to find:
mContactCompany Search performed in the companies of contacts.
mContactEmail Search performed in the emails of contacts.
mContactFirstName Search performed in the display names of contacts.
mContactLastName Search performed in the display names of contacts.
If this parameter and <Sought value 2> are not specified, the contact is sought according to <Sought value 1>.
This parameter is not available. The search cannot be performed on a second value.

<Type of search>: Optional boolean

Type of search to perform:
True to perform a "Contains" search,
False (default value) to perform an exact-match search.

Remarks

Versions 22 and later

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.

New in version 22

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.

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