Arbortext Command Language > Functions by Alphabetical Listing > get_newlist_entry
  
get_newlist_entry
get_newlist_entry (entry, array[])
Given a new dialog entry (name, description, or path), this function returns an associative array containing information about the entry. The function return code is 1 for success, 0 for failure.
entry — String indication entry. It is the base name of the document type DTD (e.g. article), the full DTD path (for example, APTPATH/doctypes/article/axdocbook.dtd), or the description that appears in the New Document dialog box (for example, Arbortext XML DocBook V4.0).
array — Associative array that will contain entry information on success. The indexes are:
name — Name of document type.
description — Description of document type as appears in the New Document dialog box.
dtdpath — The path to the document type DTD.
template — The path to the document type template as specified in the DCF file.
sample — The path to the document type sample as specified in the DCF file.
descriptionindex — Ordinal indicating the position of the description in the DCF file.
displayed — Boolean that indicates if this document type is currently being displayed in the New Document dialog box.
category — The category in which the document type appears in the New Document dialog box.