Get Page Map

Command line:
tlapi ‑cGETPMAP [‑psPhase] [‑u] ‑osMapFile sPart
Library call:
nStatus = TLgetpmap (sPart, sPhase, nUpd, nFlags, sMapFile)

Function

Create a file containing information about the pages in a partition. The information can be from the current published phase (if this exists), or from the update phase.

Arguments

sPart

The path of the partition for which the page map is to be generated.

sMapFile

The full pathname of the page map file. See below for a description of the format of this file.

sPhase

The partition phase from which to take the data. One of INITIAL, PUBLISH, UPDATE or CURRENT. Defaults to PUBLISH, so for a non-looseleaf job it is usual to select INITIAL.

nUpd

If non-zero, only changed pages are included in the page map. In the command line version, use the ‑u flag to request only changed pages.

nFlags

Options for the map file. Set this value to 1 to include the partition name in the map file.

For additional command line arguments see “Common Flag Arguments”.

Notes

The page map file is a text file.

If the first line starts with the '-' character, it is assumed that it contains the path of the original partition. The components of the path are separated by '-'.

The second and subsequent lines each contain information about a single page. Each line contains two parts: the path to the page file and the folio label of the page.

Examples

Command line:

tlapi ‑cGETPMAP ‑pINITIAL ‑oC:\pages.map manuals/topix/vol1

Library call:

status = TLgetpmap("manuals/topix/vol1", "INITIAL", 0L, 1L, "C:\\pages.map");