libspectre/spectre-status.h File Reference

#include <libspectre/spectre-macros.h>

Go to the source code of this file.

Typedefs
typedef enum _SpectreStatus	SpectreStatus
Enumerations
enum	_SpectreStatus {   SPECTRE_STATUS_SUCCESS = 0, SPECTRE_STATUS_NO_MEMORY, SPECTRE_STATUS_LOAD_ERROR, SPECTRE_STATUS_DOCUMENT_NOT_LOADED,   SPECTRE_STATUS_INVALID_PAGE, SPECTRE_STATUS_RENDER_ERROR, SPECTRE_STATUS_EXPORTER_ERROR, SPECTRE_STATUS_SAVE_ERROR }
Functions
const char *	spectre_status_to_string (SpectreStatus status)

---

Typedef Documentation

typedef enum _SpectreStatus SpectreStatus

Defines the error status of a Spectre object

---

Enumeration Type Documentation

enum _SpectreStatus

Defines the error status of a Spectre object

Enumerator:

SPECTRE_STATUS_SUCCESS	No error
SPECTRE_STATUS_NO_MEMORY	There has been a problem allocating memory
SPECTRE_STATUS_LOAD_ERROR	There has been a problem loading the postcript file
SPECTRE_STATUS_DOCUMENT_NOT_LOADED	A function that needs the document to be loaded has been called and the document has not been loaded or there was an error when loading it
SPECTRE_STATUS_INVALID_PAGE	The request page number is not in the document page range
SPECTRE_STATUS_RENDER_ERROR	There has been a problem rendering the page
SPECTRE_STATUS_EXPORTER_ERROR	There has been a problem exporting the document
SPECTRE_STATUS_SAVE_ERROR	There has been a problem saving the document

---

Function Documentation

const char* spectre_status_to_string

(

SpectreStatus

status

)

Gets a textual description of the given status

Parameters:

status

the status whose textual description will be returned

---