ContactDelete (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

Contact functions (Lotus Notes or Android/iPhone/iPad)

ContactDelete

Presentation

Example

Required application feature

See also

ContactDelete (Function)

In french: ContactSupprime

Deletes the current contact:

from a Lotus Notes or Outlook address book.
Caution: This function cannot be used to delete a contact from an Outlook Express address book.
from the list of contacts on the device (Android, iPhone or iPad, Universal Windows).

Example

// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartNotesSession("Password", "MarsServer", "email/julia.nsf", ...
"C:\Lotus Notes\julia.id")
// Find the contact to delete
IF ContactSearch(SessionID, "Smith", mContactLastName, "Adriana", mContactFirstName) = True THEN
// Delete contact
ContactDelete(SessionID)
Info("This contact was deleted")
ELSE
Info("No contact was found")
END

gCurrentContact is Contact
garrContacts is array of Contact
garrContacts = ContactList(Null)

// Delete the selected contact
gCurrentContact = garrContacts[LOOP_CONTACTS]

IF YesNo(Yes, "Do you want to delete this contact?") = Yes THEN
// Delete contact
ContactDelete(gCurrentContact)
// Refresh contacts
RefreshContacts()
END

Syntax

Deleting a contact from a Lotus Notes or Outlook address book Hide the details

<Result> = ContactDelete(<Session identifier>)

<Result>: Boolean

True if the deletion was performed,
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.

Deleting a contact from the device's contact list (Android, iPhone, iPad, Universal Windows) Hide the details

<Result> = ContactDelete(<Contact>)

<Result>: Boolean

True if the deletion was performed,
False otherwise. To get more details on the error, use ErrorInfo with the errMessage constant.

<Contact>: Contact variable

Name of the Contact variable corresponding to the contact to delete.

Remarks

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.

Business / UI classification: Business Logic

Component: wd280com.dll