Go to the documentation of this file.
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;
180 #define NULL ((void*)0)
233 typedef enum _ErrorCode {
552 #if (defined(_WIN32) || defined(_WIN64)) && !defined(SWIG)
558 explicit DateTime(
const SYSTEMTIME& systime)
559 :
year(systime.wYear)
560 ,
month(systime.wMonth)
562 ,
hour(systime.wHour)
570 operator SYSTEMTIME()
const;
571 #endif // defined(_WIN32) || defined(_WIN64)
725 Exception(
const char* file_name,
int line_number,
const char* function_name,
ErrorCode error_code);
733 : error_code_(exception.error_code_)
734 , error_message_(exception.error_message_)
735 , name_(exception.name_) {}
745 error_code_ = exception.error_code_;
746 error_message_ = exception.error_message_;
769 return error_message_;
786 #define throw(Exception)
789 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1700)
790 #define FS_FINAL final
795 #if __cpluscplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)
796 #define FS_OVERRIDE override
FX_INT64 int64
Signed 64-bit integer.
Definition: fs_basictypes.h:190
(For compliance only) Compliance resource file(s) cannot be found or opened. Please check if complian...
Definition: fs_basictypes.h:357
(Reserved, unsupported yet, For DWG-to-PDF conversion only) ODA engine is not found.
Definition: fs_basictypes.h:395
bool operator<=(const DateTime &datetime) const
Smaller or equal operator.
No "Compliance" module right.
Definition: fs_basictypes.h:375
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
No document permission to operate.
Definition: fs_basictypes.h:407
(For LTV only) Fail to load DTS.
Definition: fs_basictypes.h:350
New data conflicts with existed data.
Definition: fs_basictypes.h:271
uint16 year
Year. It should be a four-digit number, such as 2014.
Definition: fs_basictypes.h:684
Error handle.
Definition: fs_basictypes.h:246
static DateTime GetLocalTime()
Get local time.
Definition: fs_basictypes.h:452
(For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.
Definition: fs_basictypes.h:316
Definition: fs_basictypes.h:226
DateTime & operator=(const DateTime &dt)
Assign operator.
Definition: fs_basictypes.h:537
File or folder path does not exist.
Definition: fs_basictypes.h:330
FX_UINT16 uint16
16-bit unsigned integer.
Definition: fs_basictypes.h:200
uint16 month
Month. Valid range: from 1 to 12.
Definition: fs_basictypes.h:686
Current object has not been loaded yet.
Definition: fs_basictypes.h:284
No "OCR" module right.
Definition: fs_basictypes.h:371
(For ConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.
Definition: fs_basictypes.h:288
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
CFX_ArrayTemplate< float > FloatArray
An array of float values.
Definition: fs_basictypes.h:412
No "Optimizer" module right.
Definition: fs_basictypes.h:377
FX_POSITION POSITION
A value used to denote the position of an element in a collection.
Definition: fs_basictypes.h:206
(For Office-to-PDF conversion only) WPS office engine is not found.
Definition: fs_basictypes.h:389
Any unknown error occurs.
Definition: fs_basictypes.h:253
(For ConnectedPDF only) Cannot remove the security from ConnectedPDF server.
Definition: fs_basictypes.h:300
(For ConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:298
(For ConnectedPDF only) Loaded document is already a ConnectedPDF document.
Definition: fs_basictypes.h:306
(For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.
Definition: fs_basictypes.h:310
No "Conversion" module right.
Definition: fs_basictypes.h:379
(Reserved, unsupported yet) No "DWG2PDF" module right.
Definition: fs_basictypes.h:399
No "ConnectedPDF" module right.
Definition: fs_basictypes.h:363
Expected data or object is not found.
Definition: fs_basictypes.h:267
DateTime(const DateTime &dt)
Constructor, with another date and time object.
Definition: fs_basictypes.h:519
(For Office-to-PDF conversion only) No Microsoft Office is installed in current system.
Definition: fs_basictypes.h:383
Invalid password. Usually, this error may occur when loading a PDF document with password....
Definition: fs_basictypes.h:244
uint16 minute
Minute. Valid range: from 0 to 59.
Definition: fs_basictypes.h:692
int FX_STRSIZE
String size is limited to 2^31-1.
Definition: fx_string.h:35
DateTime & ToUTCTime()
Convert current object to UTC time.
FX_UINT8 uint8
8-bit unsigned integer.
Definition: fs_basictypes.h:204
bool IsValid() const
Check whether current object is valid or not.
(For OCR only) The trial for OCR module is end.
Definition: fs_basictypes.h:328
Definition: fs_basictypes.h:713
(For ConnectedPDF only) Input ACL is invalid.
Definition: fs_basictypes.h:320
FX_INT16 int16
16-bit signed integer.
Definition: fs_basictypes.h:198
(For LTV only) Fail to check DTS.
Definition: fs_basictypes.h:346
uint16 hour
Hour. Valid range: from 0 to 23.
Definition: fs_basictypes.h:690
No "PDF2Office" module right.
Definition: fs_basictypes.h:403
(For ConnectedPDF only) Input client ID is invalid.
Definition: fs_basictypes.h:322
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
Out-of-memory error occurs.
Definition: fs_basictypes.h:261
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:233
Header file for coordinate system.
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:699
Any unknown state occurs.
Definition: fs_basictypes.h:273
Cannot use current default time stamp server. Please check if default time stamp server can be used.
Definition: fs_basictypes.h:361
(For LTV only) Revocation callback for LTV has not been set.
Definition: fs_basictypes.h:342
bool Equal(FX_BSTR str) const
Check if current string is equal to another one. Case-sensitive.
No "LayoutRecognition" module right.
Definition: fs_basictypes.h:387
(For converting html to pdf only) The converted URL is on blacklist.
Definition: fs_basictypes.h:405
(For OCR only) OCR engine has not been initialized successfully.
Definition: fs_basictypes.h:324
uint16 day
Day of month. Valid range: from 1 to 31.
Definition: fs_basictypes.h:688
PDF document is encrypted by some unsupported security handler.
Definition: fs_basictypes.h:263
bool operator>(const DateTime &datetime) const
Greater operator.
#define FXSYS_wcslen
Get the length of a wide-character string.
Definition: fx_system.h:1016
void * FX_POSITION
A value used to denote the position of an element in a collection.
Definition: fx_system.h:649
(For ConnectedPDF only) Input user token is invalid.
Definition: fs_basictypes.h:292
static DateTime GetUTCTime()
Get UTC time.
FX_RECT RectI
Rectangle, in integer.
Definition: fs_basictypes.h:445
int FX_INT32
32-bit signed integer.
Definition: fx_system.h:674
std::ostream & operator<<(std::ostream &os, const CFX_ByteString &str)
Output byte string to std::ostream.
Definition: fs_basictypes.h:152
No "Accessibility" module right.
Definition: fs_basictypes.h:393
(For ConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.
Definition: fs_basictypes.h:294
(For LTV only) Fail to switch PDF verion.
Definition: fs_basictypes.h:344
BYTE STRING CLASS.
Definition: fx_string.h:317
(For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted...
Definition: fs_basictypes.h:385
wchar_t const * FX_LPCWSTR
Pointer to constant Unicode characters.
Definition: fx_system.h:725
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:484
No "AdvEdit" module right.
Definition: fs_basictypes.h:401
(For ConnectedPDF only) Cannot connect to ConnectedPDF server.
Definition: fs_basictypes.h:290
(For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.
Definition: fs_basictypes.h:304
(For Office-to-PDF conversion only) Libre office engine is not found.
Definition: fs_basictypes.h:391
FX_INT8 int8
8-bit signed integer.
Definition: fs_basictypes.h:202
Some types are not supported.
Definition: fs_basictypes.h:259
int16 utc_hour_offset
Hour of time zone. Valid range: from -12 to 12.
Definition: fs_basictypes.h:705
~Exception()
Destructor.
Definition: fs_basictypes.h:751
Definition: fx_coordinates.h:30
PointF Offset
Offset information, in float.
Definition: fs_basictypes.h:441
No "TableMaker" module right.
Definition: fs_basictypes.h:397
(For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.
Definition: fs_basictypes.h:308
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
CFX_ArrayTemplate< int32 > Int32Array
An array of signed integer values.
Definition: fs_basictypes.h:414
String GetName() const
Get the string of error code.
Definition: fs_basictypes.h:777
#define FX_FILESIZE
Support large file directly.
Definition: fx_stream.h:138
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:219
(For Office-to-PDF conversion only) Office COM has not been initialized successfully.
Definition: fs_basictypes.h:381
bool operator==(const DateTime &datetime) const
Equal operator.
ErrorCode GetErrCode() const
Get the error code.
Definition: fs_basictypes.h:758
Data of current object is invalid.
Definition: fs_basictypes.h:280
Foxit namespace.
Definition: fs_taggedpdf.h:27
FS_HANDLE Handle() const
Get the handle of current object.
Definition: fs_basictypes.h:426
DateTime()
Constructor.
Definition: fs_basictypes.h:498
(For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.
Definition: fs_basictypes.h:302
The type of input object or current object is invalid.
Definition: fs_basictypes.h:269
CFX_ByteString FX_UTF8Encode(const wchar_t *wstr)
Convert wide string to UTF-8 encoding byte string.
Definition: fs_basictypes.h:116
CFX_ArrayTemplate< PointF > PointFArray
An array of PointF objects.
Definition: fs_basictypes.h:449
Certificate error: PDF document is encrypted by digital certificate but current user does not have th...
Definition: fs_basictypes.h:251
(For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.
Definition: fs_basictypes.h:314
Parameter error: value of any input parameter for a function is invalid.
Definition: fs_basictypes.h:257
FX_DWORD FX_UINT32
unsigned 32bits integer.
Definition: fx_system.h:755
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
Exception(const Exception &exception)
Constructor, with another exception object.
Definition: fs_basictypes.h:732
uint16 second
Second. Valid range: from 0 to 60. 60 for leap second.
Definition: fs_basictypes.h:694
(For OCR only) Not enough disk space.
Definition: fs_basictypes.h:326
Data is not ready. Usually this is used as an exception error code when loading document in asynchron...
Definition: fs_basictypes.h:278
(For compliance only) Fail to initialize compliance engine.
Definition: fs_basictypes.h:336
No "Redaction" module right.
Definition: fs_basictypes.h:367
unsigned short FX_UINT16
Unsigned 16bits integer.
Definition: fx_system.h:664
bool operator<(const DateTime &datetime) const
Smaller operator.
Exception(const char *file_name, int line_number, const char *function_name, ErrorCode error_code)
Constructor, with parameters.
signed char FX_INT8
Signed 8bits integer.
Definition: fx_system.h:652
No "XFA" module right.
Definition: fs_basictypes.h:365
String GetMessage() const
Get the error message string.
Definition: fs_basictypes.h:767
#define NULL
The null-pointer value.
Definition: fx_system.h:780
unsigned char FX_UINT8
Unsigned 8bits integer.
Definition: fx_system.h:654
Definition: fx_coordinates.h:771
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
DateTime & ToLocalTime()
Convert current object to local time.
Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.
Definition: fs_basictypes.h:265
(For signature only) The signature being operated needs to be signed.
Definition: fs_basictypes.h:352
short FX_INT16
Signed 16bits integer.
Definition: fx_system.h:662
bool operator>=(const DateTime &datetime) const
Greater or equal operator.
Header file for basic data class.
Exception & operator=(const Exception &exception)
Assign operator.
Definition: fs_basictypes.h:744
FX_INT64 FILESIZE
File size. Support large file directly.
Definition: fs_basictypes.h:208
Structure for date and time.
Definition: fx_process.h:95
XFA loading error.
Definition: fs_basictypes.h:282
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
Header file for Process & thread related definitions and classes.
(For compliance only) Compliance engine has not been initialized successfully.
Definition: fs_basictypes.h:332
Definition: fs_basictypes.h:224
CFX_PointF PointF
Point information, in float.
Definition: fs_basictypes.h:439
Invalid or incorrect state.
Definition: fs_basictypes.h:286
Definition: fx_coordinates.h:596
No "RMS" module right.
Definition: fs_basictypes.h:369
(For ConnectedPDF only) Cannot get user token from ConnectedPDF server.
Definition: fs_basictypes.h:318
Definition: fx_coordinates.h:1076
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:592
No "Comparison" module right.
Definition: fs_basictypes.h:373
uint16 utc_minute_offset
Minute of time zone. Valid range: from 0 to 59.
Definition: fs_basictypes.h:707
Invalid license is used to initialize Foxit PDF SDK library.
Definition: fs_basictypes.h:255
Success, and no error occurs.
Definition: fs_basictypes.h:235
Format is invalid. For files, this may also mean that file is corrupted.
Definition: fs_basictypes.h:239
(For ConnectedPDF only) The rights of Current user has expired.
Definition: fs_basictypes.h:296
File cannot be found or could not be opened.
Definition: fs_basictypes.h:237
bool operator!=(const DateTime &datetime) const
Not equal operator.
WIDE STRING CLASS.
Definition: fx_string.h:1452
CFX_ByteString String
Byte string.
Definition: fs_basictypes.h:221
No default server has been set to time stamp server manager yet.
Definition: fs_basictypes.h:359
(For LTV only) Fail to load DSS.
Definition: fs_basictypes.h:348
Time stamp server manager has not been initialized successfully.
Definition: fs_basictypes.h:338
CFX_FloatRect RectF
Rectangle, in float.
Definition: fs_basictypes.h:443
(For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.
Definition: fs_basictypes.h:312
(For LTV only) LTV verify mode has not been set.
Definition: fs_basictypes.h:340
CFX_ArrayTemplate< RectF > RectFArray
An array of RectF objects.
Definition: fs_basictypes.h:447
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
CFX_Matrix Matrix
Matrix information, in float.
Definition: fs_basictypes.h:437
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
Definition: fs_basictypes.h:419
(For compliance only) Invalid unlock code is used to initialize compliance engine.
Definition: fs_basictypes.h:334
CFX_ArrayTemplate< uint32 > UInt32Array
An array of unsigned integer values.
Definition: fs_basictypes.h:416
@2023 Foxit Software Incorporated. All rights reserved.