What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

mcal_expunge
Prev	XXXVI. MCAL Functions	Next

mcal_expunge

Name

mcal_expunge — Delete all events marked for deletion

Synopsis

bool mcal_expunge(MCALconnection); int MCALconnection: An open MCAL connection

Returns

TRUE on success, FALSE on failure

Description

The mstore driver does not make use of the delayed-deletion functionality that this function is designed for. As soon as you call mcal_delete_event() , the event is deleted from the calendar file. However, in the future, this function may be used to confirm deletions of events from an ICAP server, in much the same way that imap_expunge() confirms deletions of emails from an IMAP server.

Version

PHP 3 since 3.0.13, PHP 4 since 4.0b4

Example

Example 721. Expunging deleted events

$calendar = "{/mstore}";
$MCALconnection = mcal_open($calendar, "username", "password");
mcal_expunge($MCALconnection);

Prev	Home	Next
mcal_event_set_title	Up	mcal_fetch_current_stream_event

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.