IBM Lotus Domino Designer 8.5
  Versions 8.5 and 8.5.1

removePermanently method

Permanently deletes a document from a database, doing a hard deletion even if soft deletions are enabled.

Note This method is new with Release 6.5.

Defined in

Document

Syntax

public boolean removePermanently(boolean force)

    throws NotesException

Parameters

boolean force

If true, the document is deleted even if another user modifies the document after the program opens it. If false, the document is not deleted if another user modifies it.

Return value

boolean

• true if the document is successfully deleted
• false if the document is not deleted, because another user modified it and the force parameter is set to false

Usage

This method does a hard deletion even if "Allow soft deletions" is enabled. See remove to do a soft deletion.

If you access a NotesDocument object through the Document property of NotesUIDocument, you can't delete the back-end document. If you could, the UI rendition would have no basis. You must access the document strictly through the back-end.

A deleted document cannot be used as a basis for navigation in a view or a document collection.

You cannot use the remove method on a Document object returned by the DocumentContext property.

Language cross-reference

RemovePermanently method in LotusScript NotesDocument class

@DeleteDocument function in formula language

@HardDeleteDocument function in formula language

See examples

---

Library | Support | Terms of use |

Last updated: Monday, October 5, 2009