NotesListItem (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

NotesListItem (Function)

In french: NotesListeChamp

Returns the list of items for the current Notes document in Lotus Notes.

Example

// 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)
// Retrieve the Lotus Notes items found in this document
ListLotusNotesItem is string
ALotusNotesItem is string
ListLotusNotesItem = NotesListItem(SessionID)
// For each Lotus Notes item
FOR EACH STRING ALotusNotesItem OF ListLotusNotesItem SEPARATED BY CR
// Add the name of the Lotus Notes item and its value into a List Box control
ListAdd(LIST_LotusNotesItem, ALotusNotesItem + CR + ...
NotesItem(SessionID, ALotusNotesItem))
END

Syntax

Returning the name of the items found in the current Notes document Hide the details

<Result> = NotesListItem(<Session identifier>)

<Result>: Character string

Name of the items found in the current Notes document, separated by CR characters (Carriage Return). The ErrorOccurred variable is set to True if an error occurs. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Session identifier>: Integer

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

Returning the name and the type of the items found in the current Notes document Hide the details

<Result> = NotesListItem(<Session identifier> , <notesLstType>)

<Result>: Character string

Name and type of the items found in the current Notes document, in the following format:

<Name of Lotus Notes Item 1> + TAB + <Type of Lotus Notes Item 1> + CR +
<Name of Lotus Notes Item 2> + TAB + <Type of Lotus Notes Item 2> + CR +...

Where:
<Name of Lotus Notes Item X> corresponds to the name of the Lotus Notes item.
<Type of Lotus Notes Item X> corresponds to the type of the Lotus Notes item. This parameter can correspond to:
notesTypeDateTime: DateTime Lotus Notes item
notesTypeUnknown: Type of Lotus Notes item not supported
notesTypeNumber: Number Lotus Notes item
notesTypeText: Text Lotus Notes item
notesTypeRichText: Rich Text Lotus Notes item (containing a formatting and possible attachments)
The ErrorOccurred variable is set to True if an error occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.

<Session identifier>: Integer

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

<notesLstType>: Constant

notesLstType: Constant used to return the type of the items found in the current Notes document.

Component : wd250mess.dll