Status Codes

Most API calls will return one of the following status codes.

Note that the exit status of a command line call to tlapi.exe will be 4 (operation failed) except where indicated in parentheses after the status code below. Use the ‑x argument to have the full status code emitted to the standard output.

Reserved for GUI interface” indicates an error generated by the TopLeaf GUI.

STATUS CODE DESCRIPTION
0 (0) Operation completed successfully
1000 Cannot open a leaf status indicator file. A leaf status indicator file is used to update, delete or assign one or more leaf status indicator strings to a partition.
1001 Read/write access denied. Cannot start the composition engine because the calling application does not have permission to write or create files in the specified partition.
1002 Cannot create the next partition update because the update already exists.
1003 An attempt to create a new update has failed because the partition does not exist, or the current update has not been committed.
1004 An attempt to create a new update has failed because the calling application does not have permission to write or create files in the specified partition.
1005 TopLeaf has been unable to create a new update for this partition. There is no associated output page for a leaf in the published phase. This error can occur when additional pages are created for leaves that have not been changed or included in the current update, or if an image file cannot be copied.
1006 Cannot create/write a partition leaf status file.
1007 An attempt to access a partition component is not valid or has failed.
1008 An attempt to commit a partition has failed because the calling application does not have permission to write or create files in the specified partition.
1009 An attempt to commit a partition has failed because the partition does not exist, or the current update has already been committed.
1010 An attempt to uncommit a partition and revert the partition phase to "update" mode has failed because the partition is already in "update mode".
1011 An attempt to uncommit a partition has failed because the calling application does not have permission to write or create files in the specified partition.
1012 An attempt to update the partition document (document check-in) has failed because the calling application does not have permission to write or create files in the specified partition.
1013 An attempt to check in a partition document failed because TopLeaf could not match a published leaf with an associated leaf in the updated document.
1014 A requested operation is not valid in this context.
1015 An attempt to preview or create a PDF for a partition failed because no page output exists.
1016 Cannot commit a partition because an input file does not exist.
1017 Cannot commit a partition because an input file was modified after the partition was typeset.
1018 An attempt to create a new update has failed because the partition's published leaf status file does not exist.
1019 An attempt to commit a partition has failed because the partition has not been typeset.
1020 An attempt to renumber a partition leaf group has failed because the partition does not exist, or the partition has been committed.
1021 An attempt to renumber a partition leaf group has failed because the partition's leaf status file does not exist.
1022 An attempt to renumber a partition leaf group has failed because the calling application does not have permission to backup files in the specified partition.
1023 An attempt to renumber a partition leaf group has failed because the calling application does not have permission to write or create directories in the specified partition.
1024 Cannot load the partition release table.
1025 Cannot write the partition release table.
1026 An attempt to access a leaf status file has failed because the calling application does not have permission to read or write the partition leaf status file.
1027 The requested operation is not valid in a mainwork.
1028 The partition has no data, or it cannot be read.
1029 An API call has failed because the TopLeaf program files directory or document repository cannot be located.
1030 An API call has failed because the specified partition does not exist or is corrupt.
1031 An API call has failed because a previous (or simultaneous) API call to the composition engine has locked the partition.
1032 An API call has failed because a previous (or simultaneous) API call to edit the partition document has locked the partition.
1033 An API call has failed because the partition has been committed.
1034 An attempt to create a new update, or uncommit the partition has failed because the partition has not been committed.
1035 The partition is not a mainwork.
1036 An attempt to uncommit the partition has failed because the partition has not been committed.
1037 An API call that creates an output file has failed because the caller has not specified the name of the output file.
1038 (2) An attempt to compose a partition document has completed with errors, or if after typesetting the partition, a post-processing program fails.
1039 (3) An attempt to compose a partition document has completed, with an abnormal exit.
1040 An attempt to pack a partition has failed because the partition does not exist, or there is no current update phase.
1041 An attempt to pack a partition has failed because the calling application does not have permission to write or create files in the specified partition.
1042 An API call has failed because the partition, or an expected component of that partition, is undefined or contains an illegal character or value.
1043 An API call has failed because the requested (or required) partition phase does not exist.
1044 An attempt to create a print image file has failed because the calling application did not specify the name of an output print device.
1045 An API call that requires an input file has failed because the caller has not specified the name of the input file.
1046 An API call has failed because the partition's leaf status file does not exist.
1047 An attempt to create a live pages and filing instructions list has failed.
1048 An attempt to leaf split a partition failed because the page management model is not full looseleaf.
1049 An attempt to update a partition document has failed because the calling application does not have permission to write files to the partition.
1050 An attempt to scrap a partition update has failed because the calling application does not have permission to write files to the partition.
1051 An attempt to scrap a partition update has failed because the partition update does not exist (that is, the partition is currently published).
1052 An attempt to update a partition document has failed because applying the document update would compromise the partition integrity.
1053 An attempt to commit a partition failed because the API could not correctly position the published leaf boundaries.
1054 An attempt to commit a partition failed because the partition was typeset with errors or warnings.
1055 An API call has failed because applying the requested action would compromise the partition integrity.
1056 An attempt to update a partition document has failed because the incoming document contains an unexpected character encoding(s). (For example, legacy documents cannot contain Unicode data.)
1057 The requested API call cannot be completed until the document is composed.
1058 An attempt to uncommit a partition failed because the published phase does not exist.
1059 An attempt to uncommit a partition failed because the previous update phase does not exist.
1060 A specified post-processing command does not exist or cannot be accessed from the command search path.
1061 An attempt to update a partition document has failed because the partition specifies a document prefilter that does not exist.
1062 An attempt to create a new partition has failed because the calling application does not have permission to write into the current document repository.
1063 An attempt to remove a partition has failed because the calling application does not have permission to remove files from the current document repository.
1064 An API call has failed because one or more required partition index files could not be extracted from the partition.
1065 An API call has failed because the caller has attempted to extract an undefined index from the partition.
1066 An attempt to commit a partition failed because an auto-export or post-processing step generated an error or warning.
1067 An attempt to create a new update has failed because the API cannot correctly position the published leaf boundaries.
1068 An attempt to export a leaf indicator file has failed because the calling application does not have permission to create the specified output (export) file.
1069 An attempt to export a leaf indicator file has failed because the partition does not exist, or the specified input file is not defined.
1070 Reserved for GUI interface.
1071 Reserved for GUI interface.
1072 Reserved for GUI interface.
1073 Not used
1074 Not used.
1075 An attempt to renumber a partition leaf group failed because the target folio is already defined within the leaf set.
1076 An attempt to renumber a partition leaf group failed because the leaf group to be renumbered does not exist.
1077 The API call failed because the calling application has attempted to set an undefined partition property.
1078 Reserved for GUI interface (failed to locate legacy document).
1079 Reserved for GUI interface (failed to locate legacy document format file).
1080 Reserved for GUI interface (failed to create legacy document partition).
1081 Reserved for GUI interface (failed to update legacy document file).
1082 An attempt to update the partition leaf indicators has failed because the partition leaf status file does not exist.
1083 Reserved for GUI interface.
1084 Reserved for GUI interface.
1085 Reserved for GUI interface.
1086 Reserved for GUI interface (an API call has attempted to access an undefined member of a partition booklist).
1087 Reserved for GUI interface (an API call has failed to add a specified document to the partition booklist).
1088 An attempt to manually include one or more leaves has failed because the <tl:leaf.list> file does not exist.
1089 The published leaf inspector has failed to verify one or more published leaf boundaries.
1090 The API has been unable to locate the partition document for the requested phase (update or published).
1091 An attempt to label the current release has failed because the release string is not defined.
1092 Reserved for GUI interface.
1093 An attempt to create a PDF document has completed, with errors.
1094 An attempt to create a PDF document has failed.
1095 (1) An attempt to compose a partition document has completed, with warnings.
1096 An attempt to commence document composition has failed.
1097 A required parameter was missing, or the API call is not supported on this platform.
1098 An attempt to create a partition has failed because one or more specified partition property files do not exist.
1099 An attempt to create a partition has failed because the partition already exists.
1100 An attempt has been made to add a partition with associated control files. One or more control files have not been included because they already exist in the target publication.
1101 Transformation document was created, but with warnings. Use the GETSTAT call to retrieve the log.
1102 Transformation document was not created. Use the GETSTAT call to retrieve the log.
1103 No input file could be found for the transformation — compose the partition to create it.
1104 The format information for the partition could not be found.
1105 An output file for a transformation cannot be created; it may be in use by another application.
1106 An undefined typeface was referenced.
1107 An attempt to commit a partition failed because the change page processing failed.
1108 An attempt to commit a partition failed because there were one or more duplicate page identifiers.
1109 The PDF could not be created because no matching partitions were found.
1110 Reserved for GUI interface.
1111 Reserved for GUI interface.
1112 Reserved for GUI interface.
1113 The TopLeaf print previewer reported an error.
1114 An attempt to generate a published leaf set from an initial set of boundaries failed.
1115 An attempt to create a PDF document failed because no input data was available.
1116 An attempt to change the current TopLeaf repository failed.
1117 It is not valid to create a partition in the TopLeaf root directory
1118 Created a partition with an undefined style file
1119 Created a partition with an undefined macro file
1120 Created a partition with an undefined mapping file
1121 Created a partition with an undefined DTD file
1122 Created a partition with an undefined CATALOG file
1123 Cannot find the published document folder
1124 Cannot copy the published document folder
1125 Cannot create the published graphics folder
1126 Cannot create stylesheet archive.
1127 Stylesheet archive has invalid format.
1128 Error when importing stylesheet archive.
1129 Cannot create stylesheet archive folder.
1130 Cannot write stylesheet archive path to file.
1131 The requested partition component file does not exist.
1132 No output format type was specified for a transformation.
1133 The style sheet was created by a later build of TopLeaf.
1134 The typesetting engine does not exist.
1135 A required style sheet component does not exist.
1136 An API function failed due to a licensing problem.
1146 Failed when attempting to create the stylesheet source.
1147 Could not upgrade to XML stylesheet; check that stylesheet file does not already exist.
1148 A fatal error occurred when upgrading to an XML stylesheet.
1149 Stylesheet source missing or invalid.
1150 Stylesheet could not be compiled.
1151 Could not load color palette.
1152 Layout source missing or invalid.
1153 Layout could not be compiled.
1154 Could not write to the output file. The file may be open in another application.
1155 A specified post-processing command reported an error.
1156 Could not find or create font configuration file (font.cfg).
1157 An index sort request reported an error.
1158 Cannot create the output page files folder.
1159 Cannot create the generated files folder.
1160 Cannot create the excluded page files folder.
1161 Cannot create the published page files folder
1162 Cannot create the temporary page files folder.
1163 Cannot create the release output folder.
1164 Cannot create the published leaves folder.
1165 Operation not permitted with a standard license.
1166 Unable to create the partition package.
1167 Unable to load the partition package.
1168 Cannot package a partition in the publish phase.
1169 Partition property file does not exist.
1170 Partition property file path is not declared.
1171 Cannot open/read partition property file.
1172 Cannot lock/write partition property file.
1173 Cannot write a partition property.
1174 Cannot create partition property file.
1175 Cannot create partition property backup file.
1176 Cannot remove existing partition property file.
1177 Cannot remove partition property lock file.
1178 The partition does not exist.
1179 A manually included <tl:leaf.list> file referenced one or more undefined leaves.
1201 The location of the java™ runtime is not defined or is incorrect.
2000 An undefined or unsupported API function was specified.