OfficeConvertError Class Documentation

class OfficeConvertError : Error

Namespace:datalogics_interface

Inherits from:
Error

Detailed Description

Thrown by Document::from_office_file when a document does not convert. Carries the plug-in's status code and message as well as what(), which reads "[Category] detail".

Constructor & Destructor Documentation

OfficeConvertError

OfficeConvertError(Category category, int plugin_result_code, const std::string & detail)

Parameters

category: Category

What kind of failure.

plugin_result_code: int

The plug-in's status, or -1 when the plug-in never answered.

detail: const std::string &

The plug-in's message, or curator's when the plug-in never answered.

Member Function Documentation

category

Category category()

Returns:

Category

What kind of failure.

detail

const std::string & detail()

Returns:

const std::string &

The plug-in's message, or curator's when the plug-in never answered.

get_error_code

DL_ERROR_MEMBER int get_error_code()

Returns:

DL_ERROR_MEMBER int

The Adobe PDF Library error code, or 0 when the failure carries none.

Decode the value with the APDFL ErrGetSeverity, ErrGetSystem and ErrGetCode macros, or compare it against a whole code.

plugin_result_code

int plugin_result_code()

Returns:

int

The plug-in's status code, or -1 when the plug-in never answered.