NotesDocumentFirst (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

NotesDocumentFirst (Function)

In french: NotesDocumentPremier

Positions on the first document found in Lotus Notes. This document becomes the current document.

In most cases, NotesDocumentFirst is used in a read loop with NotesDocumentNext.

Example

// Open the connection
SessionID is int
SessionID = 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(SessionID, "email/julia.nsf")
IF DatabaseID = 0 THEN
Error(ErrorInfo())
ELSE
...
// Read the first document
NotesDocumentFirst(DatabaseID)
// Enumerate the documents found
WHILE NotesOut(DatabaseID) = False
// Display the name of the documents in a List Box control
ListAdd(LIST_DocumentsFound, NotesItem(DatabaseID, "Name"))
// Next document found
NotesDocumentNext(DatabaseID)
END
END

// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartNotesSession("Password", "MarsServer", ...
"mail\julia.nsf", "C:\Users\Julia\AppData\Local\Lotus\Notes\Data\user.id")
...
// Read the first document
NotesDocumentFirst(SessionID)
// Enumerate the documents found
WHILE NotesOut(SessionID) = False
// Display the name of the documents in a List Box control
ListAdd(LIST_DocumentsFound, NotesItem(SessionID, "Name"))
// Next document found
NotesDocumentNext(SessionID)
END

Syntax

<Result> = NotesDocumentFirst(<Session identifier>)

<Result>: Boolean

True if the first document was read,
False otherwise. The ErrorOccurred variable is set to True if an error occurred.
To get the details of the error, use ErrorInfo with the errMessage constant.
If no document was found, the ErrorOccurred variable remains set to False and NotesOut returns True.

<Session identifier>: Integer

Identifier of session to use. This identifier is returned by EmailStartNotesSession or by NotesOpenDatabase.

Component: wd260mess.dll