THPDFRTFImportStatus Type
Reports how an RTF import finished, including which guard rail brought it to a halt
Declaration
THPDFRTFImportStatus= (risSuccess, risInvalidInput,
risDocumentNotReady, risWrongThread, risInputLimit,
risCharacterLimit, risPageLimit, risMetafileLimit,
risCancelled, risNoProgress, risRenderError);Unit
HPDFDoc
Values
| Value | Purpose |
|---|---|
risSuccess | The RTF source was converted in full and the resulting pages were added |
risInvalidInput | The RTF source is empty or cannot be read as RTF |
risDocumentNotReady | The target document was not in a state able to accept imported pages |
risWrongThread | The import was called from a thread unable to run the VCL-based converter |
risInputLimit | The source went past MaxInputBytes from THPDFRTFImportOptions |
risCharacterLimit | The source went past the MaxCharacters limit |
risPageLimit | The converted output went past the MaxPages limit |
risMetafileLimit | A metafile embedded in the RTF went past MaxMetafileBytes |
risCancelled | The caller-supplied cancellation token fired whilst conversion was under way |
risNoProgress | Metafile playback stopped making forward progress and the import gave up |
risRenderError | The metafile-to-page rendering step did not succeed |
Usage notes
- The status lands in
THPDFRTFImportStatistics.Statusbeside counters such asPagesRenderedandMetafileBytes, which stay meaningful for partial results - The limit values (
risInputLimit,risCharacterLimit,risPageLimit,risMetafileLimit) map straight onto the matching guard fields ofTHPDFRTFImportOptions - Check
risWrongThreadfirst in service scenarios, because RTF conversion uses VCL facilities that demand the main thread