plugin_error.h File Reference

#include "config.h"
Include dependency graph for plugin_error.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define GENERIC_STATUS_START   0
 Definition of error code for specific functions.
#define RENDER_SETTINGS_STATUS_START   30

Enumerations

enum  PluginStatus {
  PLUGIN_OK = GENERIC_STATUS_START, PLUGIN_FAIL, PLUGIN_OUT_OF_BUFFER, PLUGIN_NOT_SUPPORTED,
  PLUGIN_ERROR_OPEN_FILE, PLUGIN_OUT_OF_MEMORY, PLUGIN_UNSUPPORTED_ENCODING, PLUGIN_ANCHOR_NOT_AVAILABLE,
  PLUGIN_LIC_ERROR_OPENING, PLUGIN_LIC_NOT_ACTIVATED_ADOBE, PLUGIN_LIC_EXPIRED, PLUGIN_NO_LOAN_INFO_FOUND,
  PLUGIN_DOCUMENT_CORRUPT, PLUGIN_PDF_PASSWORD_NEEDED, PLUGIN_EPUB_USERNAMEPASSWORD_NEEDED, PLUGIN_BN_EPUB_CREDITCARDINFO_NEEDED,
  PLUGIN_BN_PDB_CREDITCARDINFO_NEEDED, PLUGIN_CREDENTIALS_AUTHORIZATION_FAILED, PLUGIN_CREDENTIALS_AUTHORIZATION_PENDING, PLUGIN_CORRUPT_ACTIVATION_FILE,
  PLUGIN_MAX_ZOOM_ALREADY = RENDER_SETTINGS_STATUS_START, PLUGIN_MIN_ZOOM_ALREADY
}
 

Plugin status Please keep these entries as generic as possible, plugin specific names should be avoided. https://tracker.irexnet.com/view.php?id=2913 describes future improvements for the error handling. Please note when adding entries, to also update ViewCtrl::get_error_message.

More...

Define Documentation

#define GENERIC_STATUS_START   0

Definition of error code for specific functions.

Copyright (C) 2008 iRex Technologies B.V. All rights reserved. PluginStatus Function return code definition

Definition at line 43 of file plugin_error.h.

#define RENDER_SETTINGS_STATUS_START   30

Definition at line 44 of file plugin_error.h.


Enumeration Type Documentation

Plugin status Please keep these entries as generic as possible, plugin specific names should be avoided. https://tracker.irexnet.com/view.php?id=2913 describes future improvements for the error handling. Please note when adding entries, to also update ViewCtrl::get_error_message.

See also:
ViewCtrl::get_error_message
Enumerator:
PLUGIN_OK 
PLUGIN_FAIL 
PLUGIN_OUT_OF_BUFFER 
PLUGIN_NOT_SUPPORTED 
PLUGIN_ERROR_OPEN_FILE 
PLUGIN_OUT_OF_MEMORY 
PLUGIN_UNSUPPORTED_ENCODING 
PLUGIN_ANCHOR_NOT_AVAILABLE 
PLUGIN_LIC_ERROR_OPENING 
PLUGIN_LIC_NOT_ACTIVATED_ADOBE 
PLUGIN_LIC_EXPIRED 
PLUGIN_NO_LOAN_INFO_FOUND 
PLUGIN_DOCUMENT_CORRUPT 
PLUGIN_PDF_PASSWORD_NEEDED 
PLUGIN_EPUB_USERNAMEPASSWORD_NEEDED 
PLUGIN_BN_EPUB_CREDITCARDINFO_NEEDED 
PLUGIN_BN_PDB_CREDITCARDINFO_NEEDED 
PLUGIN_CREDENTIALS_AUTHORIZATION_FAILED 
PLUGIN_CREDENTIALS_AUTHORIZATION_PENDING 
PLUGIN_CORRUPT_ACTIVATION_FILE 
PLUGIN_MAX_ZOOM_ALREADY 
PLUGIN_MIN_ZOOM_ALREADY 

Definition at line 52 of file plugin_error.h.

00053 {
00054     // Generic
00055     PLUGIN_OK                   = GENERIC_STATUS_START,
00056     PLUGIN_FAIL,
00057     PLUGIN_OUT_OF_BUFFER,
00058     PLUGIN_NOT_SUPPORTED,
00059     PLUGIN_ERROR_OPEN_FILE,
00060     PLUGIN_OUT_OF_MEMORY,
00061     PLUGIN_UNSUPPORTED_ENCODING,
00062     PLUGIN_ANCHOR_NOT_AVAILABLE,
00063     
00064     // Licensing problem
00065     PLUGIN_LIC_ERROR_OPENING,   // Document not licensed correctly or belongs to other user. Reported during opening of document.
00066     PLUGIN_LIC_NOT_ACTIVATED_ADOBE,   // The user has not been activated yet. Reported during opening of document.
00067     PLUGIN_LIC_EXPIRED,         // License for this document has expired
00068     PLUGIN_NO_LOAN_INFO_FOUND,  // No loan information found. 
00069     
00070     PLUGIN_DOCUMENT_CORRUPT,
00071 
00072     PLUGIN_PDF_PASSWORD_NEEDED,              // (Adobe PDF) password needed
00073     PLUGIN_EPUB_USERNAMEPASSWORD_NEEDED,      // EPUB Username/password combination needed
00074     PLUGIN_BN_EPUB_CREDITCARDINFO_NEEDED,     // B&N EPUB DRM creditcard info needed
00075     PLUGIN_BN_PDB_CREDITCARDINFO_NEEDED,      // B&N legacy PDB DRM creditcard info needed
00076 
00077     PLUGIN_CREDENTIALS_AUTHORIZATION_FAILED, // Credential authorization failed
00078     PLUGIN_CREDENTIALS_AUTHORIZATION_PENDING,   // Credentials could not be verified, UDS has to reopen the document
00079     
00080     PLUGIN_CORRUPT_ACTIVATION_FILE,           // (Adobe DRM) corrupt activation file, maybe tampering
00081        
00082     // Render settings
00083     PLUGIN_MAX_ZOOM_ALREADY     = RENDER_SETTINGS_STATUS_START,
00084     PLUGIN_MIN_ZOOM_ALREADY,
00085 } PluginStatus;

Generated by  doxygen 1.6.2-20100208