NotesDeleteAttachment (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

NotesDeleteAttachment (Function)

In french: NotesSupprimeFichierAttaché

Deletes an attached file from an item of the current document in Lotus Notes.

To take the deletion of this file into account, the document must be saved by NotesSave.

Example

// Open the connection
ConnectionID is int
ConnectionID = NotesOpenConnection("Password", "MarsServer", ...
"C:\Users\Julia\AppData\Local\Lotus\Notes\Data\user.id")
// Specify the Lotus Notes database to use
DatabaseID is int
DatabaseID = NotesOpenDatabase(ConnectionID, "julia.nsf")
...
// Read the first document
NotesDocumentFirst(DatabaseID)
...
// Number of files attached to the "MyLotusNotesItem" item in the current Notes document
NbFiles is int
NbFiles = NotesNbAttachment(DatabaseID, "MyLotusNotesItem")
// Delete the last attached file
NotesDeleteAttachment(DatabaseID, "MyLotusNotesItem", NbFiles)
// Take this deletion into account
NotesSave(DatabaseID)

Syntax

<Result> = NotesDeleteAttachment(<Session identifier> , <Lotus Notes item> , <File index>)

<Result>: Boolean

True if the file was deleted,
False otherwise. If an error occurs, the ErrorOccurred variable is set to True. 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 or NotesOpenDatabase.

<Lotus Notes item>: Character string

Name of the Lotus Notes item (Rich Text) to which the file is attached.
Each item of a Notes document can contain up to 256 attached files.
To know the name and type of the items in the current Notes document, use NotesListItem.

<File index>: Character string

Subscript of the file to delete. This subscript corresponds to the rank of the file in the list of files for the Lotus Notes item (for example, the subscript of the 3rd attached file will be 3).
Caution: The indices of the files are modified when a file is deleted.

Component: wd270mess.dll