Vanilla.PDF  1.5.2
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 {
29 
34 
39 
44 
49  } TimezoneType;
50 
59  VANILLAPDF_API error_type CALLING_CONVENTION Date_CreateEmpty(DateHandle** result);
60 
64  VANILLAPDF_API error_type CALLING_CONVENTION Date_CreateCurrent(DateHandle** result);
65 
69  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetYear(DateHandle* handle, integer_type* result);
70 
74  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetYear(DateHandle* handle, integer_type value);
75 
79  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMonth(DateHandle* handle, integer_type* result);
80 
84  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetMonth(DateHandle* handle, integer_type value);
85 
89  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetDay(DateHandle* handle, integer_type* result);
90 
94  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetDay(DateHandle* handle, integer_type value);
95 
99  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetHour(DateHandle* handle, integer_type* result);
100 
104  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetHour(DateHandle* handle, integer_type value);
105 
109  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMinute(DateHandle* handle, integer_type* result);
110 
114  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetMinute(DateHandle* handle, integer_type value);
115 
119  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetSecond(DateHandle* handle, integer_type* result);
120 
124  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetSecond(DateHandle* handle, integer_type value);
125 
129  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetTimezone(DateHandle* handle, TimezoneType* result);
130 
134  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetTimezone(DateHandle* handle, TimezoneType value);
135 
139  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetHourOffset(DateHandle* handle, integer_type* result);
140 
144  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetHourOffset(DateHandle* handle, integer_type value);
145 
149  VANILLAPDF_API error_type CALLING_CONVENTION Date_GetMinuteOffset(DateHandle* handle, integer_type* result);
150 
154  VANILLAPDF_API error_type CALLING_CONVENTION Date_SetMinuteOffset(DateHandle* handle, integer_type value);
155 
159  VANILLAPDF_API error_type CALLING_CONVENTION Date_ToUnknown(DateHandle* handle, IUnknownHandle** result);
160 
164  VANILLAPDF_API error_type CALLING_CONVENTION Date_FromUnknown(IUnknownHandle* handle, DateHandle** result);
165 
170  VANILLAPDF_API error_type CALLING_CONVENTION Date_Release(DateHandle* handle);
171 
174 #ifdef __cplusplus
175 };
176 #endif
177 
178 #endif /* _C_DATE_H */
Signifies that local time is equal to UT.
Definition: c_date.h:38
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_SetMinuteOffset(DateHandle *handle, integer_type value)
Get minute offset represented by this object. Range of values (0-59)
error_type Date_SetTimezone(DateHandle *handle, TimezoneType value)
Relationship of local time to Universal Time (UT).
error_type Date_SetHourOffset(DateHandle *handle, integer_type value)
Get hour offset represented by this object. Range of values (0-23)
error_type Date_ToUnknown(DateHandle *handle, IUnknownHandle **result)
Reinterpret current object as IUnknownHandle.
error_type Date_FromUnknown(IUnknownHandle *handle, DateHandle **result)
Convert IUnknownHandle to ObjectHandle.
error_type Date_SetMinute(DateHandle *handle, integer_type value)
Get minutes represented by this object. Range of values (0-59)
error_type Date_SetYear(DateHandle *handle, integer_type value)
Get year represented by this object.
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.
Undefined unitialized default value, triggers error when used.
Definition: c_date.h:33
error_type Date_SetDay(DateHandle *handle, integer_type value)
Get day index in month represented by this object. Range of values (1-31)
error_type Date_SetSecond(DateHandle *handle, integer_type value)
Get seconds represented by this object. Range of values (0-59)
Signifies that local time is earlier than UT.
Definition: c_date.h:48
error_type Date_SetHour(DateHandle *handle, integer_type value)
Get hours in day represented by this object. Range of values (0-23)
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:43
Base class for reference counting.
error_type Date_GetMonth(DateHandle *handle, integer_type *result)
Get month in specified year represented by this object. Range of values (1-12)
error_type Date_SetMonth(DateHandle *handle, integer_type value)
Get month in specified year represented by this object. Range of values (1-12)