common.h File Reference

Description

Typedef Documentation

lxw_row_t

typedef uint32_t lxw_row_t

Integer data type to represent a row value. Equivalent to uint32_t.

The maximum row in Excel is 1,048,576.

lxw_col_t

typedef uint16_t lxw_col_t

Integer data type to represent a column value. Equivalent to uint16_t.

The maximum column in Excel is 16,384.

lxw_error

typedef enum lxw_error lxw_error

See the lxw_strerror() function for an example of how to convert the enum number to a descriptive error message string.

lxw_datetime

typedef struct lxw_datetime lxw_datetime

Struct to represent a date and time in Excel. See Working with Dates and Times.

Enumeration Type Documentation

lxw_boolean

enum lxw_boolean

Boolean values used in libxlsxwriter.

Enumerator
LXW_FALSE	False value.
LXW_TRUE	True value.
LXW_EXPLICIT_FALSE	False value. Used to turn off a property that is default on, in order to distinguish it from an uninitialized value.

lxw_error

enum lxw_error

See the lxw_strerror() function for an example of how to convert the enum number to a descriptive error message string.

Enumerator
LXW_NO_ERROR	No error.
LXW_ERROR_MEMORY_MALLOC_FAILED	Memory error, failed to malloc() required memory.
LXW_ERROR_CREATING_XLSX_FILE	Error creating output xlsx file. Usually a permissions error.
LXW_ERROR_CREATING_TMPFILE	Error encountered when creating a tmpfile during file assembly.
LXW_ERROR_READING_TMPFILE	Error reading a tmpfile.
LXW_ERROR_ZIP_FILE_OPERATION	Zip generic error ZIP_ERRNO while creating the xlsx file.
LXW_ERROR_ZIP_PARAMETER_ERROR	Zip error ZIP_PARAMERROR while creating the xlsx file.
LXW_ERROR_ZIP_BAD_ZIP_FILE	Zip error ZIP_BADZIPFILE (use_zip64 option may be required).
LXW_ERROR_ZIP_INTERNAL_ERROR	Zip error ZIP_INTERNALERROR while creating the xlsx file.
LXW_ERROR_ZIP_FILE_ADD	File error or unknown zip error when adding sub file to xlsx file.
LXW_ERROR_ZIP_CLOSE	Unknown zip error when closing xlsx file.
LXW_ERROR_FEATURE_NOT_SUPPORTED	Feature is not currently supported in this configuration.
LXW_ERROR_NULL_PARAMETER_IGNORED	NULL function parameter ignored.
LXW_ERROR_PARAMETER_VALIDATION	Function parameter validation error.
LXW_ERROR_PARAMETER_IS_EMPTY	Function string parameter is empty.
LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED	Worksheet name exceeds Excel's limit of 31 characters.
LXW_ERROR_INVALID_SHEETNAME_CHARACTER	Worksheet name cannot contain invalid characters: '[ ] : * ? / \'
LXW_ERROR_SHEETNAME_START_END_APOSTROPHE	Worksheet name cannot start or end with an apostrophe.
LXW_ERROR_SHEETNAME_ALREADY_USED	Worksheet name is already in use.
LXW_ERROR_32_STRING_LENGTH_EXCEEDED	Parameter exceeds Excel's limit of 32 characters.
LXW_ERROR_128_STRING_LENGTH_EXCEEDED	Parameter exceeds Excel's limit of 128 characters.
LXW_ERROR_255_STRING_LENGTH_EXCEEDED	Parameter exceeds Excel's limit of 255 characters.
LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED	String exceeds Excel's limit of 32,767 characters.
LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND	Error finding internal string index.
LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE	Worksheet row or column index out of range.
LXW_ERROR_WORKSHEET_MAX_URL_LENGTH_EXCEEDED	Maximum hyperlink length (2079) exceeded.
LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED	Maximum number of worksheet URLs (65530) exceeded.
LXW_ERROR_IMAGE_DIMENSIONS	Couldn't read image dimensions or DPI.

Data Structures
struct	lxw_datetime
	Struct to represent a date and time in Excel. More...

Typedefs
typedef uint32_t	lxw_row_t
typedef uint16_t	lxw_col_t
typedef enum lxw_error	lxw_error
	Error codes from libxlsxwriter functions.
typedef struct lxw_datetime	lxw_datetime
	Struct to represent a date and time in Excel.

Enumerations
enum	lxw_boolean { LXW_FALSE , LXW_TRUE , LXW_EXPLICIT_FALSE }
enum	lxw_error {   LXW_NO_ERROR = 0 , LXW_ERROR_MEMORY_MALLOC_FAILED , LXW_ERROR_CREATING_XLSX_FILE , LXW_ERROR_CREATING_TMPFILE ,   LXW_ERROR_READING_TMPFILE , LXW_ERROR_ZIP_FILE_OPERATION , LXW_ERROR_ZIP_PARAMETER_ERROR , LXW_ERROR_ZIP_BAD_ZIP_FILE ,   LXW_ERROR_ZIP_INTERNAL_ERROR , LXW_ERROR_ZIP_FILE_ADD , LXW_ERROR_ZIP_CLOSE , LXW_ERROR_FEATURE_NOT_SUPPORTED ,   LXW_ERROR_NULL_PARAMETER_IGNORED , LXW_ERROR_PARAMETER_VALIDATION , LXW_ERROR_PARAMETER_IS_EMPTY , LXW_ERROR_SHEETNAME_LENGTH_EXCEEDED ,   LXW_ERROR_INVALID_SHEETNAME_CHARACTER , LXW_ERROR_SHEETNAME_START_END_APOSTROPHE , LXW_ERROR_SHEETNAME_ALREADY_USED , LXW_ERROR_32_STRING_LENGTH_EXCEEDED ,   LXW_ERROR_128_STRING_LENGTH_EXCEEDED , LXW_ERROR_255_STRING_LENGTH_EXCEEDED , LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED , LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND ,   LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE , LXW_ERROR_WORKSHEET_MAX_URL_LENGTH_EXCEEDED , LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED , LXW_ERROR_IMAGE_DIMENSIONS ,   LXW_MAX_ERRNO }
	Error codes from libxlsxwriter functions. More...