This function declares the atipl namespace, adds page layout markup to a document, and returns the status of the operation. The added markup consists of atipl singletons. The flags parameter is a bit mask used to control the markup inserted. The file parameter specifies the location of the layout file that drives the operation. This layout file is generated automatically when line numbering is applied to a document.

If the operation fails because the source document was write protected or missing, or the layout file is not found or improper, then this function returns -1. If the document is modified but some markup could not be inserted in the required location, then this function returns 0. Otherwise, the call is successful and this function returns 1.

The failure to insert some layout tags in the appropriate locations is expected in some applications (for example, CALS change pages with generated text, tables of contents, and so on). In these cases the atipl tag is inserted at the nearest previous location where it is legal to do so, and the error attribute of the markup is set to 1.

The flag bits control the type of structure markup to add to the document. These bits are:

The default behavior when flags is not specified is to output all structures.

For more detailed information on the page layout elements and their attributes, see PTC Arbortext Help Center. Refer to the Programmer's Reference for more detailed information about line numbering applications.