Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
c_date.h
Go to the documentation of this file.
1 #ifndef _C_DATE_H
2 #define _C_DATE_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
28  typedef enum {
33 
38 
43  } TimezoneType;
44 
53  VANILLAPDF_API error_type CALLING_CONVENTION Date_CreateEmpty(DateHandle** result);
54 
58  VANILLAPDF_API error_type CALLING_CONVENTION Date_CreateCurrent(DateHandle** result);
59 
63  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetYear(DateHandle* handle, integer_type* result);
64 
68  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMonth(DateHandle* handle, integer_type* result);
69 
73  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetDay(DateHandle* handle, integer_type* result);
74 
78  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetHour(DateHandle* handle, integer_type* result);
79 
83  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMinute(DateHandle* handle, integer_type* result);
84 
88  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetSecond(DateHandle* handle, integer_type* result);
89 
93  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetTimezone(DateHandle* handle, TimezoneType* result);
94 
98  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetHourOffset(DateHandle* handle, integer_type* result);
99 
103  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMinuteOffset(DateHandle* handle, integer_type* result);
104 
109  VANILLAPDF_API error_type CALLING_CONVENTION Date_Release(DateHandle* handle);
110 
113 #ifdef __cplusplus
114 };
115 #endif
116 
117 #endif /* _C_DATE_H */
Signifies that local time is equal to UT.
Definition: c_date.h:32
error_type Date_GetMinute(DateHandle *handle, integer_type *result)
Get minutes represented by this object. Range of values (0-59)
error_type Date_Release(DateHandle *handle)
Decrement the internal reference counter.
error_type Date_GetHourOffset(DateHandle *handle, integer_type *result)
Get hour offset represented by this object. Range of values (0-23)
error_type Date_CreateEmpty(DateHandle **result)
Create a new blank date instance.
error_type Date_GetMinuteOffset(DateHandle *handle, integer_type *result)
Get minute offset represented by this object. Range of values (0-59)
This file contains all type forward declarations returned by the library API.
error_type Date_GetTimezone(DateHandle *handle, TimezoneType *result)
Relationship of local time to Universal Time (UT).
error_type Date_GetHour(DateHandle *handle, integer_type *result)
Get hours in day represented by this object. Range of values (0-23)
error_type Date_CreateCurrent(DateHandle **result)
Get current date in UTC format.
Represents a reference to a particular day represented within a calendar system.
Signifies that local time is earlier than UT.
Definition: c_date.h:42
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
This file contains macro declarations for importing and exporting symbols from library boundaries...
int32_t integer_type
32-bit signed integer
Definition: c_types.h:51
error_type Date_GetSecond(DateHandle *handle, integer_type *result)
Get seconds represented by this object. Range of values (0-59)
error_type Date_GetDay(DateHandle *handle, integer_type *result)
Get day index in month represented by this object. Range of values (1-31)
error_type Date_GetYear(DateHandle *handle, integer_type *result)
Get year represented by this object.
TimezoneType
Relationship of local time to Universal Time (UT).
Definition: c_date.h:28
This file contains types and constants used as parameters or return values.
Signifies that local time is later than UT.
Definition: c_date.h:37
error_type Date_GetMonth(DateHandle *handle, integer_type *result)
Get month in specified year represented by this object. Range of values (1-12)