Standard result returned by almost all functionalities of this component. Indicates whether
the operation succeeded, and whether it ended in an error or with a non-blocking warning.
| Property |
Description |
| Error |
true if the operation failed; in that case no file/result was generated. |
| ErrorMessage |
Descriptive error message. Empty if Error is false. |
| Warning |
true if the operation completed successfully but there is a non-blocking condition worth reviewing (for example, a font that could not be resolved in Generate PDF from HTML and was replaced by another one). |
| WarningMessage |
Descriptive warning message. Empty if Warning is false. |
-
It is recommended to always check Error first; if it is true, the rest of the invoked
functionality's result (generated file, returned values, etc.) should not be considered valid.
-
Warning is independent of Error: it can only be true when the operation succeeded
(Error = false). It indicates that the file/result was indeed generated, but the warning
message is worth reviewing.
&PDFToolsStatus = &PDFToolsUtils.AddText(&PDFFileSource,&PDFFileTarget,
&Text,
&PDFPage,
&PDFTextPositionX,&PDFTextPositionY,&PDFTextAngle,
&PDFTextFontSize,&PDFTextColorRed,&PDFTextColorGreen,&PDFTextColorBlue,
&PDFTextOpacity)
if &PDFToolsStatus.Error
// handle the error, for example show &PDFToolsStatus.ErrorMessage
else
if &PDFToolsStatus.Warning
// the file was generated anyway; review &PDFToolsStatus.WarningMessage
endif
endif