The ArchiveServerIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS ArchiveSerevrby scripting means. More...

Public Member Functions
AccessProfile	first ()
	Retrieve the first ArchiveServer object in the ArchiveServerIterator. More...

String	getLastError ()
	Function to get the description of the last error that occurred. More...

AccessProfile	next ()
	Retrieve the next ArchiveServer object in the ArchiveServerIterator. More...

int	size ()
	Get the amount of ArchiveServer objects in the ArchiveServerIterator. More...

Detailed Description

The ArchiveServerIterator class has been added to the DOCUMENTS PortalScripting API to gain full access to the DOCUMENTS ArchiveSerevrby scripting means.

Since: DOCUMENTS 5.0a

Member Function Documentation

◆ first()

AccessProfile ArchiveServerIterator::first ( )

Retrieve the first ArchiveServer object in the ArchiveServerIterator.

Returns: ArchiveServer or null in case of an empty ArchiveServerIterator

Since: DOCUMENTS 5.0a

◆ getLastError()

String ArchiveServerIterator::getLastError ( )

Function to get the description of the last error that occurred.

Returns: Text of the last error as String

Since: DOCUMENTS 5.0a

◆ next()

AccessProfile ArchiveServerIterator::next ( )

Retrieve the next ArchiveServer object in the ArchiveServerIterator.

Returns: ArchiveServer or null if end of ArchiveServerIterator is reached.

Since: DOCUMENTS 5.0a

◆ size()

int ArchiveServerIterator::size ( )

Get the amount of ArchiveServer objects in the ArchiveServerIterator.

Returns: integer value with the amount of ArchiveServer objects in the ArchiveServerIterator