16 #ifndef FS_BASIC_TYPES_H_ 17 #define FS_BASIC_TYPES_H_ 35 #if defined(_WIN32) || defined(_WIN64) 37 #endif // defined(_WIN32) || defined(_WIN64) 39 #define FSDK_DEFINE_ARRAY(ArrayName, Type) \ 40 class ArrayName : public Object { \ 50 ArrayName(const ArrayName& other); \ 56 ArrayName& operator = (const ArrayName& other); \ 61 size_t GetSize() const; \ 67 Type GetAt(size_t index) const; \ 73 Type& operator[](size_t index) const; \ 79 void Add(const Type& element); \ 86 void RemoveAt(size_t index); \ 94 void InsertAt(size_t index, const Type& element); \ 129 return str2.
Equal(str1);
141 return !str2.
Equal(str1);
153 return os << (
const char*) str;
165 return os << (
const wchar_t*) str;
168 #if !defined(_SWIG_ANDROID_) && !defined(_SWIG_IOS_) && !defined(_SWIG_JAVA_) 181 #define NULL ((void*)0) 230 #if !defined(_SWIG_ANDROID_) && !defined(_SWIG_JAVA_) 236 typedef enum _ErrorCode {
532 #if (defined(_WIN32) || defined(_WIN64)) && !defined(SWIG) 539 :
year(systime.wYear)
540 ,
month(systime.wMonth)
542 ,
hour(systime.wHour)
550 operator SYSTEMTIME()
const;
551 #endif // defined(_WIN32) || defined(_WIN64) 705 Exception(
const char* file_name,
int line_number,
const char* function_name,
ErrorCode error_code);
713 : error_code_(exception.error_code_)
714 , error_message_(exception.error_message_)
715 , name_(exception.name_) {}
725 error_code_ = exception.error_code_;
726 error_message_ = exception.error_message_;
749 return error_message_;
766 #define throw(Exception) 769 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1700) 770 #define FS_FINAL final 775 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600) 776 #define FS_OVERRIDE override DateTime & operator=(const DateTime &dt)
Assign operator.
Definition: fs_basictypes.h:517
Invalid or incorrect state.
Definition: fs_basictypes.h:289
ErrorCode GetErrCode() const
Get the error code.
Definition: fs_basictypes.h:738
int16 utc_hour_offset
Hour of time zone. Valid range: from -12 to 12.
Definition: fs_basictypes.h:685
String GetMessage() const
Get the error message string.
Definition: fs_basictypes.h:747
Invalid password. Usually, this error may occur when loading a PDF document with password....
Definition: fs_basictypes.h:247
(For compliance only) Compliance resource file(s) cannot be found or opened. Please check if complian...
Definition: fs_basictypes.h:360
DateTime & ToLocalTime()
Convert current object to local time.
No "Conversion" module right.
Definition: fs_basictypes.h:382
(For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
Definition: fs_basictypes.h:307
(For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
Definition: fs_basictypes.h:319
PointF Offset
Offset information, in float.
Definition: fs_basictypes.h:421
Format is invalid. For files, this may also mean that file is corrupted.
Definition: fs_basictypes.h:242
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
(For compliance only) Invalid unlock code is used to initialize compliance engine.
Definition: fs_basictypes.h:337
DateTime(const DateTime &dt)
Constructor, with another date and time object.
Definition: fs_basictypes.h:499
uint16 minute
Minute. Valid range: from 0 to 59.
Definition: fs_basictypes.h:672
(For compliance only) Fail to initialize compliance engine.
Definition: fs_basictypes.h:339
void Set(uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second, uint16 milliseconds, int16 utc_hour_offset, uint16 utc_minute_offset)
Set value.
Definition: fs_basictypes.h:572
(For LTV only) Fail to check DTS.
Definition: fs_basictypes.h:349
No "RMS" module right.
Definition: fs_basictypes.h:372
FX_DWORD FX_UINT32
unsigned 32bits integer.
Definition: fx_system.h:742
Data of current object is invalid.
Definition: fs_basictypes.h:283
wchar_t const * FX_LPCWSTR
Pointer to constant Unicode characters.
Definition: fx_system.h:712
FX_UINT8 uint8
8-bit unsigned integer.
Definition: fs_basictypes.h:206
Definition: fs_basictypes.h:226
Definition: fs_basictypes.h:432
(For OCR only) Not enough disk space.
Definition: fs_basictypes.h:329
bool operator<(const DateTime &datetime) const
Smaller operator.
File or folder path does not exist.
Definition: fs_basictypes.h:333
uint16 hour
Hour. Valid range: from 0 to 23.
Definition: fs_basictypes.h:670
DateTime(uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second, uint16 milliseconds, int16 utc_hour_offset, uint16 utc_minute_offset)
Constructor, with parameters.
Definition: fs_basictypes.h:464
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:214
uint16 milliseconds
Millisecond. Valid range: from 0 to 999. PDF standard does not support now, this can be omitted if it...
Definition: fs_basictypes.h:679
Definition: fx_coordinates.h:30
(For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
Definition: fs_basictypes.h:317
uint16 year
Year. It should be a four-digit number, such as 2014.
Definition: fs_basictypes.h:664
No default server has been set to time stamp server manager yet.
Definition: fs_basictypes.h:362
No "XFA" module right.
Definition: fs_basictypes.h:368
File cannot be found or could not be opened.
Definition: fs_basictypes.h:240
(For ConnectedPDF only) Cannot connect to ConnectedPDF server.
Definition: fs_basictypes.h:293
uint16 month
Month. Valid range: from 1 to 12.
Definition: fs_basictypes.h:666
(For LTV only) Fail to load DSS.
Definition: fs_basictypes.h:351
Error handle.
Definition: fs_basictypes.h:249
PDF document is encrypted by some unsupported security handler.
Definition: fs_basictypes.h:266
No "Compliance" module right.
Definition: fs_basictypes.h:378
Exception & operator=(const Exception &exception)
Assign operator.
Definition: fs_basictypes.h:724
WIDE STRING CLASS.
Definition: fx_string.h:1452
std::ostream & operator<<(std::ostream &os, const CFX_ByteString &str)
Output byte string to std::osstream.
Definition: fs_basictypes.h:152
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:221
void * FX_POSITION
A value used to denote the position of an element in a collection.
Definition: fx_system.h:636
Cannot use current default time stamp server. Please check if default time stamp server can be used.
Definition: fs_basictypes.h:364
(For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:297
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:194
(For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
Definition: fs_basictypes.h:291
(For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
Definition: fs_basictypes.h:321
bool operator==(const DateTime &datetime) const
Equal operator.
uint16 day
Day of month. Valid range: from 1 to 31.
Definition: fs_basictypes.h:668
(For OCR only) OCR engine has not been initialized successfully.
Definition: fs_basictypes.h:327
Structure for date and time.
Definition: fx_process.h:95
Definition: fs_basictypes.h:693
(For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
Definition: fs_basictypes.h:386
No "Optimizer" module right.
Definition: fs_basictypes.h:380
Parameter error: value of any input parameter for a function is invalid.
Definition: fs_basictypes.h:260
__int64 FX_INT64
Signed 64-bit integer.
Definition: fx_system.h:716
static DateTime GetUTCTime()
Get UTC time.
Current object has not been loaded yet.
Definition: fs_basictypes.h:287
No "ConnectedPDF" module right.
Definition: fs_basictypes.h:366
Invalid license is used to initialize Foxit PDF SDK library.
Definition: fs_basictypes.h:258
int FX_INT32
32-bit signed integer.
Definition: fx_system.h:661
bool operator >(const DateTime &datetime) const
Greater operator.
(For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
Definition: fs_basictypes.h:303
int FX_STRSIZE
String size is limited to 2^31-1.
Definition: fx_string.h:35
FS_HANDLE Handle() const
Get the handle of current object.
Definition: fs_basictypes.h:406
(For ConnectedPDF only) Input ACL is invalid.
Definition: fs_basictypes.h:323
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
(For Office-to-PDF conversion only) Office COM has not been initialized successfully.
Definition: fs_basictypes.h:384
The type of input object or current object is invalid.
Definition: fs_basictypes.h:272
(For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
Definition: fs_basictypes.h:315
Data is not ready. Usually this is used as an exception error code when loading document in asynchron...
Definition: fs_basictypes.h:281
Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.
Definition: fs_basictypes.h:268
Certificate error: PDF document is encrypted by digital certificate but current user does not have th...
Definition: fs_basictypes.h:254
CFX_FloatRect RectF
Rectangle, in float.
Definition: fs_basictypes.h:423
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:212
#define FXSYS_wcslen
Get the length of a wide-character string.
Definition: fx_system.h:1003
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
CFX_ByteString FX_UTF8Encode(const wchar_t *wstr)
Convert wide string to UTF-8 encoding byte string.
Definition: fs_basictypes.h:116
signed char FX_INT8
Signed 8bits integer.
Definition: fx_system.h:639
CFX_PointF PointF
Point information, in float.
Definition: fs_basictypes.h:419
(For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
Definition: fs_basictypes.h:309
CFX_ArrayTemplate< int32 > Int32Array
An array of integer values.
Definition: fs_basictypes.h:396
(For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
Definition: fs_basictypes.h:311
Any unknown state occurs.
Definition: fs_basictypes.h:276
(For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:301
bool operator<=(const DateTime &datetime) const
Smaller or equal operator.
Time stamp server manager has not been initialized successfully.
Definition: fs_basictypes.h:341
bool operator >=(const DateTime &datetime) const
Greater or equal operator.
No "OCR" module right.
Definition: fs_basictypes.h:374
FX_POSITION POSITION
A value used to denote the position of an element in a collection.
Definition: fs_basictypes.h:208
Exception(const char *file_name, int line_number, const char *function_name, ErrorCode error_code)
Constructor, with parameters.
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:192
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
(For compliance only) Compliance engine has not been initialized successfully.
Definition: fs_basictypes.h:335
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:223
(For LTV only) LTV verify mode has not been set.
Definition: fs_basictypes.h:343
FX_INT64 FILESIZE
File size. Support large file directly.
Definition: fs_basictypes.h:210
Header file for Process & thread related definitions and classes.
(For ConnectedPDF only) Input client ID is invalid.
Definition: fs_basictypes.h:325
FX_INT8 int8
8-bit signed integer.
Definition: fs_basictypes.h:204
unsigned short FX_UINT16
Unsigned 16bits integer.
Definition: fx_system.h:651
(For OCR only) The trial for OCR module is end.
Definition: fs_basictypes.h:331
(For signature only) The signature being operated needs to be signed.
Definition: fs_basictypes.h:355
Definition: fx_coordinates.h:596
CFX_Matrix Matrix
Matrix information, in float.
Definition: fs_basictypes.h:417
DateTime()
Constructor.
Definition: fs_basictypes.h:478
unsigned char FX_UINT8
Unsigned 8bits integer.
Definition: fx_system.h:641
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:196
New data conflicts with existed data.
Definition: fs_basictypes.h:274
Definition: fs_basictypes.h:399
(For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
Definition: fs_basictypes.h:313
Definition: fs_basictypes.h:228
String GetName() const
Get the string of error code.
Definition: fs_basictypes.h:757
bool operator !=(const DateTime &datetime) const
Not equal operator.
uint16 second
Second. Valid range: from 0 to 60. 60 for leap second.
Definition: fs_basictypes.h:674
uint16 utc_minute_offset
Minute of time zone. Valid range: from 0 to 59.
Definition: fs_basictypes.h:687
FX_INT16 int16
16-bit signed integer.
Definition: fs_basictypes.h:200
Foxit namespace.
Definition: fs_compare.h:27
XFA loading error.
Definition: fs_basictypes.h:285
unsigned __int64 FX_UINT64
Unsigned 64-bit integer.
Definition: fx_system.h:718
short FX_INT16
Signed 16bits integer.
Definition: fx_system.h:649
(For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
Definition: fs_basictypes.h:305
No "Comparison" module right.
Definition: fs_basictypes.h:376
Exception(const Exception &exception)
Constructor, with another exception object.
Definition: fs_basictypes.h:712
BYTE STRING CLASS.
Definition: fx_string.h:317
FX_UINT16 uint16
16-bit unsigned integer.
Definition: fs_basictypes.h:202
Header file for basic data class.
static DateTime GetLocalTime()
Get local time.
(For LTV only) Fail to load DTS.
Definition: fs_basictypes.h:353
#define NULL
The null-pointer value.
Definition: fx_system.h:767
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
CFX_ArrayTemplate< PointF > PointFArray
An array of PointF objects.
Definition: fs_basictypes.h:429
Definition: fx_coordinates.h:1076
Success, and no error occurs.
Definition: fs_basictypes.h:238
CFX_ArrayTemplate< RectF > RectFArray
An array of RectF objects.
Definition: fs_basictypes.h:427
bool Equal(FX_BSTR str) const
Check if current string is equal to another one. Case-sensitive.
Any unknown error occurs.
Definition: fs_basictypes.h:256
#define FX_FILESIZE
Support large file directly.
Definition: fx_stream.h:138
Expected data or object is not found.
Definition: fs_basictypes.h:270
Header file for coordinate system.
(For ConnectedPDF only) Input user token is invalid.
Definition: fs_basictypes.h:295
No "Redaction" module right.
Definition: fs_basictypes.h:370
(For ConnectedPDF only) The rights of Current user has expired.
Definition: fs_basictypes.h:299
(For LTV only) Revocation callback for LTV has not been set.
Definition: fs_basictypes.h:345
~Exception()
Destructor.
Definition: fs_basictypes.h:731
DateTime(const SYSTEMTIME &systime)
Constructor, with SYSTEMTIME in Windows.
Definition: fs_basictypes.h:538
DateTime & ToUTCTime()
Convert current object to UTC time.
(For LTV only) Fail to switch PDF verion.
Definition: fs_basictypes.h:347
Out-of-memory error occurs.
Definition: fs_basictypes.h:264
bool IsValid() const
Check whether current object is valid or not.
CFX_ArrayTemplate< float > FloatArray
An array of float values.
Definition: fs_basictypes.h:394
(For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted...
Definition: fs_basictypes.h:388
FX_RECT RectI
Rectangle, in integer.
Definition: fs_basictypes.h:425
Definition: fx_coordinates.h:771
Some types are not supported.
Definition: fs_basictypes.h:262