SearchPageByIndex(LogonID, Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState, FolderId, IsTemplate, ResolveDependancies, ReturnAsObjectBases, SortBy, SortAsc, StartIndex, PageSize, ResultsLimit)

Used to find all objects matching a certain search criteria and return the results as chunks of information.

Parameter	Type	Explanation
LogonID	String	ID returned from LogOn function.
Code	Integer	The Object Key of the object to be returned
Description	String	Description of Objects to return. Accepts wildcards. Leave blank if you don't want to filter on Description.
BasedOn	String	The name of the Object Template. Accepst wildcards. Leave blank if you don't want to filter on BasedOn.
ObjectType	String	On of (AllTypes, Book, File, Glossary, HypertextLink, Index, IndexEntry, MacroProcedure, Media, Style, TableOfContents, TableOfFigures, TitlePage or Topic)
FromDate	String	Can be left blank. The format of the string may be interpreted differently under different locales. So the format YYYY/MM/DD is recommended.
ToDate	String	Can be left blank. The format of the string may be interpreted differently under different locales. So the format YYYY/MM/DD is recommended.
ContainingText	String	Can be left blank. Accepts wildcards.
InBook	Integer	Either the ObjectId of the Book to search or 0 to ignore books.
ReleaseState	String	Either the name of the Release State or blank to ignore the release states
FolderId	Integer	The FolderId of the folder to search -1 to search all folders
IsTemplate	Integer	-1 - ignore template status 0 - non templates 1 - templates
ResolveDependancies	Boolean	True - resolve dependencies False - ignore dependencies
ReturnAsObjectBases	Boolean	True - return as object bases False - return as ObjectIds
SortBy	Integer	An integer with a specific value as defined by ObjectSearchSortBy
SortAsc	Boolean	True - sort ascending False - sort descending
StartIndex	Integer	Use in conjunction with the PageSize setting
PageSize	Integer	Use in conjunction with the PageSize setting
ResultsLimit	Integer	The maximum number of results to return. -1 if you want all matches Note: defaults to 2000 unless a setting is added to the Authorit.Config to override.

Using StartIndex and PageSize parameters

The StartIndex and PageSize parameters are used together to allow search results to be returned as smaller manageable chunks of data. Decide what size chunk you want (PageSize) and increment the StarIndex by this each time you want a new chunk. For example, to get the first 20 objects that match a criteria you would use:

	SearchPageByIndex(...StartIndex:=0, PageSize:=20, ...)

To request the next 20 objects

	SearchPageByIndex(...StartIndex:=20, PageSize:=20, ...)

etcetera

Increasing the default ResultLimits of 2000

Add an option to the Authroit.Config file:

<options>

	<option name="MaxSearchResults">1000000</option>

</options>

SearchPageByIndex(LogonID, Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState, FolderId, IsTemplate, ResolveDependancies, ReturnAsObjectBases, SortBy, SortAsc, StartIndex, PageSize, ResultsLimit)

Using StartIndex and PageSize parameters

Increasing the default ResultLimits of 2000

See Also