Arbortext Command Language > Functions by Alphabetical Listing > doc_list
  
doc_list
doc_list (arr[, flags])
 
This function fills the array arr with a list of all existing documents, returning the number of document identifiers stored in the array.
flags is a bitmask that specifies which document identifiers are returned. It is constructed by ORing the flags from the following list:
1 — include command window documents
2 — include paste buffers
4 — include "textwin" documents, that is, documents associated with the built-in text windows helpwin[1-4] and msgwin[1-4].
16 — include file entity documents
32 — include FOSI documents
64 — include top level documents that use a DTD and are not file entities or paste buffers.
128 — include documents that use a built-in document type, such as ascii or help, which is not matched by any of the flags specified above (that is, does not include documents matched by bits 1, 2, 4, and 8).
If flags is omitted or 0, then all documents are returned as if all bits were specified.