ConvertResult class
ConvertResult class
Contains the output of a successful document-to-Markdown conversion.
All Convert methods throw on failure, so a returned ConvertResult always represents a successful conversion. Use ConvertResult.content to read the Markdown string (when converting to string) and ConvertResult.warnings to check for non-fatal issues.
The ConvertResult type exposes the following members:
Methods
| Method | Description |
|---|---|
| failure | Creates a failed result with error information. |
| success | Creates a successful result without content. Used when the output was written to a stream or file. |
| success | Creates a successful result containing the converted Markdown content. |
Properties
| Property | Description |
|---|---|
| content | The converted Markdown content as a string. |
| error_message | The error message if the conversion failed, or None if it succeeded. |
| exception | The exception that caused the conversion to fail, or None if the conversion succeeded. |
| is_success | The conversion succeeded flag indicating whether the conversion completed successfully. |
| warnings | The non-fatal warnings that occurred during conversion. |
See Also
- module
groupdocs.markdown