Debug

PDF Xpress provides the ability to control the level of information written to the debug log, as well as the ability to turn off writing to a debug log file completely.

Control Debugging Information

Use the methods and properties below to adjust the settings of your debugging for optimal performance.

To generate a debug log file, set Debug to true.
The log file is kept at the location specified by DebugLogFile.
Set the ErrorLevel to Development or Detailed to indicate the level of detail logged.

VB Example	Copy Code
'This code demonstrates turning on the debug log and specifying the error level as well as the location that the log file is written to On Error GoTo error Dim pdfxpress1 As new PdfXpress pdfxpress1.Initialize pdfxpress1.RaiseExceptions = True pdfxpress1.Debug = True pdfxpress1.DebugLogFile = "c:\pdfxpress.log" pdfxpress1.DebugErrorLevel = PDF_ErrorLevel_Detailed . . . GoTo finish error: MsgBox Err.Description finish: Set document = Nothing pdfxpress1.Terminate Set pdfxpress1= Nothing

VB Example

Copy Code

'This code demonstrates turning on the debug log and specifying the error level as well as the location that the log file is written to 
On Error GoTo error
Dim pdfxpress1 As new PdfXpress
pdfxpress1.Initialize
pdfxpress1.RaiseExceptions = True
pdfxpress1.Debug = True
pdfxpress1.DebugLogFile = "c:\pdfxpress.log"
pdfxpress1.DebugErrorLevel = PDF_ErrorLevel_Detailed
.
.
.
GoTo finish
error:
MsgBox Err.Description
finish:

Set document = Nothing
pdfxpress1.Terminate
Set pdfxpress1= Nothing

Error Codes

Error Codes	Error Type	Cause
12000	Argument Out Of Range	Out of range
12003	Bad parameter	Bad parameter
12127	Set Not Supported	Not supported
12201	File does not begin with %PDF-	The file does not start correctly
12340	This operation is not permitted	The operation is not permitted
12373	Invalid Page Number	The page number is invalid
12378	This document requires authentication/password	A password was not given or incorrect
12411	Annotation index is out of range	Out of range
13001	A file error has occurred.	File error
13017	This file cannot be found	The file was not found
13151	Bad Parameter	Bad parameter was passed in
13152	The value is too large	Too large a value was used
13153	Unsupported variant type	Unsupported variant type
13154	The array is fixed or temporarily locked	A fixed or locked array
13656	Failed to render page contents	The page did not render
13657	File overwrite error	The file could not be overwritten
13658	Page number out of range	The page number is out of range
13659	The supplied image can not be directly used as a thumbnail	Supplied image can not be used as a thumbnail
13660	Out of memory, memory allocation failed	Memory allocation error
13661	PDF Xpress has not been licensed for this function	Licensing error
13662	The reported size of the TIFF image exceeds the actual size of the TIFF document in memory	Size error
13663	Bad Parameter	Bad parameter
13664	Error opening or reading a file	Error opening or reading a file
13665	Error saving an empty PDF file	PDF file save error
13666	Failed to acquire a mutually exclusive STL thread lock	Thread lock error
13667	Initialization failed	Failed to initialize
13668	Cannot create file.	Unable to create file error
13669	The annotation was not found	Unable to find annotation
13670	The annotation does not possess a name	No name for the annotation
13671	The operation was stopped	Operation stopped error
13672	The XML Schema is not supported	XML Schema not supported
13656	Unmarshal failed	Unmarshal failed error
13656	PublicId=, SystemId=XdboUnmarshaller, Line=1, Column=1, Message=Invalid document structure	Invalid document structure
13674	Marshal failed	Marshal failed
13675	Terminate filed	Terminate failed error
13676	The bookmark has already been deleted	Bookmark deleted error
13678	The date format was malformed. Date strings must adhere to the PDF date format as defined in the PDF Reference, section 3.8.3	Date malformed
13677	Annotation Missing Subtype	Annotation missing a subtype
13682	The Workspace referenced is not valid.	Workspace invalid
13683	The reference is of the wrong type	Reference is wrong type error