AS_Layer.ASDate (Acrobat)

	Typedef
	ASDate An opaque object holding information for a particular date and time. All ASDate objects are guaranteed to give accurate representation of UTC time, unadjusted for leap seconds. This is due to the fact that the introduction of leap seconds to the international calendar does not happen according to a well-defined rule.

	Enumeration
	`ASDateTimeFormat` A constant indicating a string format for representing a date and time.

	Method
	void ASDateAddCalendarTimeSpan(ASDate date, const ASCalendarTimeSpan timeSpan) Adds a calendar time span to a date. It modifies the date by the length of time provided in the ASCalendarTimeSpan object.
	void ASDateAddTimeSpan(ASDate date, const ASTimeSpan timeSpan) Adds a time span (an exact number of seconds) to a date. It modifies the date by the length of time provided in the ASTimeSpan object.
	void ASDateCalendarDiff(const ASDate date1, const ASDate date2, ASCalendarTimeSpan result) Calculates the difference between two ASDate objects and stores the result in the provided ASCalendarTimeSpan object. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month.
	void ASDateClear(ASDate retVal) Reinitializes a date object to the newly-allocated state, as returned by ASDateNew().
	ASInt32 ASDateCompare(const ASDate date1, const ASDate date2) Tests whether one date is earlier or later than another.
	void ASDateCopy(const ASDate original, ASDate copy) Copies date and time data from one date object to another.
	void ASDateDestroy(ASDate date) Releases and destroys a date object.
	ASDate ASDateDup(const ASDate date) Creates a new date object containing the same data as an existing date object.
	void ASDateExactDiff(const ASDate date1, const ASDate date2, ASTimeSpan result) Calculates the exact difference in seconds between two date objects and stores the result in the provided ASTimeSpan object. If date1 is earlier than date2, the result is negative.
	ASTimeRec ASDateGetLocalTime(const ASDate date) Creates a time record that represents the local time represented by the date object. The resulting local time might not account for daylight savings time correctly if the date object has been modified by adding or substracting a time span or calendar time span. It raises an exception if there is not enough memory.
	char* ASDateGetTimeString(const ASDate date, ASDateTimeFormat format) Creates a time string from a date object according to a specified format. If time zone information is available in the date object, the string contains the local time along with the time zone adjustment, if that is supported by the requested format. It raises an exception if there is not enough memory.
	ASTimeRec ASDateGetUTCTime(const ASDate date) Creates a time record that represents the UTC time represented by the date object. It raises an exception if there is not enough memory.
	ASDate ASDateNew() Creates a date object. The newly allocated object reflects the epoch time: Jan 1 1970 00:00:00 UTC.
	void ASDateSetLocalTimeOffset(ASDate date) Sets a date object's local time offset according to the operating system's current time zone information. Different operating systems handle daylight savings differently. This method causes the date object to always use the same daylight savings time offset that the operating system is currently using, even if the date object is modified.
	void ASDateSetTimeFromRec(ASDate date, const ASTimeRec* timeRec) Initializes a date object from a time record. It raises an exception if the time structure represents an invalid time, such as January 32nd 1999 or Feb 29th 2001. It assumes that the parameters for the day and month in the time record are 1-based.
	void ASDateSetTimeFromString(ASDate date, const char* timeString, ASDateTimeFormat format) Initializes a date object from a time string. It raises an exception if there is not enough memory, if the format is unrecognized, or if the time string is not formatted according to the supplied format.
	void ASDateSetToCurrentLocalTime(ASDate date) Sets a date object to the current local time, using the time zone information from the operating system.
	void ASDateSetToCurrentUTCTime(ASDate retVal) Sets a date object to the current UTC time with no time zone information.
	void ASDateSubtractCalendarTimeSpan(ASDate date, const ASCalendarTimeSpan timeSpan) Subtracts a calendar time span from a date. It modifies the date by the length of time provided in the ASCalendarTimeSpan object.
	void ASDateSubtractTimeSpan(ASDate date, const ASTimeSpan timeSpan) Subtracts a time span (an exact number of seconds) from a date. It modifies the date by the length of time provided in the ASTimeSpan object.

Typedefs Detail

ASDate

Product availability: All

Platform availability: All

Syntax

typedef struct _t_ASDateRec* ASDate;

An opaque object holding information for a particular date and time. All ASDate objects are guaranteed to give accurate representation of UTC time, unadjusted for leap seconds. This is due to the fact that the introduction of leap seconds to the international calendar does not happen according to a well-defined rule.

See Also

ASDateGetCurrentLocalTime

File: ASExpT.h

Line: 4046

Enumeration Detail

ASDateTimeFormat

Product availability: All

Platform availability: All

Syntax

enum ASDateTimeFormat {

  kASTimeNone = 0,


 


  kASTimePDF,


 


  kASTimeUniversal,


 


  kASTimeUniversalH,


 


  kASTimeUTC_ASN1,


 


  kASTimeGENERALIZED_ASN1

}

File: ASExpT.h

Line: 4019

Elements

	kASTimeNone	None.

	kASTimePDF	PDF date format, as defined in the PDF Reference.

	kASTimeUniversal	Slight variations of the time format expressed in ISO 8601.

	kASTimeUniversalH	Slight variations of the time format expressed in ISO 8601.

	kASTimeUTC_ASN1	UTC ASN1 format.

	kASTimeGENERALIZED_ASN1	ASN1 format.

Method Detail

ASDateAddCalendarTimeSpan

()

Product availability: All

Platform availability: All

Syntax





void ASDateAddCalendarTimeSpan(ASDate date, const ASCalendarTimeSpan timeSpan)

Adds a calendar time span to a date. It modifies the date by the length of time provided in the ASCalendarTimeSpan object.

Parameters

	`date` —	The date.

	`timeSpan` —	The calendar time span to add.

Since

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
ASDate	Typedefs \| Enumerations \| Methods

	kASTimeNone = 0,

	kASTimePDF,

	kASTimeUniversal,

	kASTimeUniversalH,

	kASTimeUTC_ASN1,

	kASTimeGENERALIZED_ASN1

	`date1` —	The first date.

	`date2` —	The second date.

	`result` —	The calendar time span structure in which to store the difference.

	`original` —	The date to be copied.

	`copy` —	The date into which the data is copied.

	`date` —	The date object.

	`format` —	The format of the time string.

	`date` —	The date object.

	`timeString` —	The time string, in the specified format.

	`format` —	The format of the time string. kASTimeNone and kASTimeUniversalH are not supported.

Layer	AS_Layer
Object	ASDate