9 69 DOM_GET_NXT_DOCUMENT

LANSA Technical

9.69 DOM_GET_NXT_DOCUMENT

Þ Note: Built-In Function Rules.

Gets the first or next Note ID from the ID Table created by a previous DOM_SEARCH_DOCUMENTS Built-In Function call.

To return the Note ID of the first document in the ID Table set the Previous Note ID argument to 0 otherwise it should be set to the value returned from a previous call to this Built-In Function.

The returned Note ID should then be processed as required by the DOM_OPEN_DOCUMENT, DOM_GET_ITEM, DOM_UPDATE_ITEM, DOM_UPDATE_DOCUMENT,... Built-In Functions.

When the processing of all documents is complete the DOM_END_SEARCH_DOCS Built-In Function must be used.

For use with

LANSA for i

YES

Visual LANSA for Windows

YES

Visual LANSA for Linux

NO

 

 

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Note ID Table handle

4

4

 

 

2

N

Req

Previous Note ID:

Set to 0 to return the first Note ID in the ID Table otherwise set to the previously returned Note ID.

1

15

0

0

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Return code

OK = Next Note ID returned successfully.

EF = No more Note Ids in the ID Table.

ER = Error returning next Note ID.

2

2

 

 

2

N

Req

Note ID returned

1

15

0

0

 

 

Examples

Refer to these Domino Built-In Function examples:

Example 2: Selecting documents from a Database using a view

Example 4: Updating Documents selected from a Browselist

Technical Notes

This Built-In Function uses the standard Lotus Notes API IDScan. All security and integrity issues related to the use of this Built-In Function are according to normal Lotus Notes API use for the current platform.