DocGetAllPages

DocGetAllPages returns a vector of all page handles for the given document or page handle.

hvPage = DocGetAllPages(hDoc)

hvPage = DocGetAllPages(hDoc, bShowProgress)

hvPage = DocGetAllPages(hDoc, bShowProgress, bUpdateFields)

hvPage = DocGetAllPages(hPage)

hvPage = DocGetAllPages(hPage, bShowProgress)

hvPage = DocGetAllPages(hPage, bShowProgress, bUpdateFields)

Return Value

hvPage is a vector of page handles. The order of the handles is identical with the order of the pages in the document. In case of an error hvPage is 0.

Parameters

hDoc

Identifies the document.

hPage

Identifies a document page. If hPage is specified the function uses the GetParent function to retrieve the document handle.

bShowProgress

If bShowProgress is TRUE (1) a progress bar is displayed in the status bar. Default value is FALSE (0).

bUpdateFields

If bUpdateFields is TRUE (1) the field functions will be updated. This can slow down the function significantly. Default value is TRUE (1).

History

Version	Description
5.7.0	New Parameter bUpdateFields.
5.3.4	New.

See also

Overview Documents, Overview Document Pages, DocSelectPage, DocLoadPage

_id-5168