CkDateTime Ruby Reference Documentation

CkDateTime

Current Version: 10.1.0

A class for holding a date/time value, and for converting it to from many different formats. The power of this class is that the different date/time formats are implemented across many different operating systems. Many formats specific to Windows are available on Mac OS X, Linux/Unix, etc., and vice-versa. To convert a date/time from one format to another, simply set via one format, and get via another format. This is a freeware class because it is used by many commercial Chilkat components/libs.

Object Creation

obj = Chilkat::CkDateTime.new()

Properties

DebugLogFilePath

# strVal is a string
# ckStr is a CkString
ckDateTime.get_DebugLogFilePath(ckStr);
strVal = ckDateTime.debugLogFilePath();
ckDateTime.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

IsDst

# intVal is an integer
intVal = ckDateTime.get_IsDst();

This is the Daylight Saving Time flag. It can have one of three possible values: 1, 0, or -1. It has the value 1 if Daylight Saving Time is in effect, 0 if Daylight Saving Time is not in effect, and -1 if the information is not available.

Note: This is NOT the DST for the current system time. It is the DST that was in effect at the date value contained in this object.

LastErrorHtml

# strVal is a string
# ckStr is a CkString
ckDateTime.get_LastErrorHtml(ckStr);
strVal = ckDateTime.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText

# strVal is a string
# ckStr is a CkString
ckDateTime.get_LastErrorText(ckStr);
strVal = ckDateTime.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# strVal is a string
# ckStr is a CkString
ckDateTime.get_LastErrorXml(ckStr);
strVal = ckDateTime.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess

# boolVal is a boolean
boolVal = ckDateTime.get_LastMethodSuccess();
ckDateTime.put_LastMethodSuccess(boolVal);

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

Any method that returns a string.
Any method returning a Chilkat object, binary bytes, or a date/time.
Any method returning a standard boolean status value where success = true and failure = false.
Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

UtcOffset

# intVal is an integer
intVal = ckDateTime.get_UtcOffset();

For the current system's timezone, returns the number of seconds offset from UTC for this date/time. The offset includes daylight savings adjustment. Local timezones west of UTC return a negative offset.

Utf8

# boolVal is a boolean
boolVal = ckDateTime.get_Utf8();
ckDateTime.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

VerboseLogging

# boolVal is a boolean
boolVal = ckDateTime.get_VerboseLogging();
ckDateTime.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

# strVal is a string
# ckStr is a CkString
ckDateTime.get_Version(ckStr);
strVal = ckDateTime.version();

Version of the component/library, such as "9.5.0.94"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddDays

# numDays is an integer
status = ckDateTime.AddDays(numDays);

Adds an integer number of days to the date/time. To subtract days, pass a negative integer.

Returns true for success, false for failure.

AddSeconds

# numSeconds is an integer
status = ckDateTime.AddSeconds(numSeconds);

Introduced in version 9.5.0.65

Adds an integer number of seconds to the date/time. To subtract seconds, pass a negative integer.

Returns true for success, false for failure.

More Information and Examples

DateTime - Add or Subtract Seconds

DeSerialize

# serializedDateTime is a string
ckDateTime.DeSerialize(serializedDateTime);

Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.

DiffSeconds

# dateTimeArg is a CkDateTime
retInt = ckDateTime.DiffSeconds(dateTimeArg);

Introduced in version 9.5.0.65

Returns the difference in seconds between the dateTimeArg and this date/time. The value returned is this object's date/time - dateTimeArg's date/time. For example, if the returned value is positive, then this object's date/time is more recent than dateTimeArg's date/time. If the return value is negative, then this object's date/time is older than dateTimeArg's date/time.

More Information and Examples

Compute Difference Between Two DateTime Strings

ExpiresWithin

# n is an integer
# units is a string
retBool = ckDateTime.ExpiresWithin(n, units);

Introduced in version 9.5.0.67

Returns true if the date/time is within n seconds/minutes/hours/days of the current system date/time. Otherwise returns false. The units can be "seconds", "minutes", "hours", or "days" (plural or singular).

More Information and Examples

Date/Time Expires Within N Seconds/Minutes/Hours/Days

GetAsDateTimeTicks

# bLocal is a boolean
retInt64 = ckDateTime.GetAsDateTimeTicks(bLocal);

Returns the date/time as a 64-bit integer .NET DateTime value.

bLocal indicates whether a local or UTC time is returned.

This is a date and time expressed in the number of 100-nanosecond intervals that have elapsed since January 1, 0001 at 00:00:00.000 in the Gregorian calendar.

The DateTime value type represents dates and times with values ranging from 12:00:00 midnight, January 1, 0001 Anno Domini (Common Era) through 11:59:59 P.M., December 31, 9999 A.D. (C.E.).

Time values are measured in 100-nanosecond units called ticks, and a particular date is the number of ticks since 12:00 midnight, January 1, 0001 A.D. (C.E.) in the GregorianCalendar calendar (excluding ticks that would be added by leap seconds). For example, a ticks value of 31241376000000000L represents the date, Friday, January 01, 0100 12:00:00 midnight. A DateTime value is always expressed in the context of an explicit or default calendar.

GetAsDosDate

# bLocal is a boolean
retInt = ckDateTime.GetAsDosDate(bLocal);

Returns the date/time as a 32-bit DOS date/time bitmask.

bLocal indicates whether a local or UTC time is returned.

The DOS date/time format is a bitmask:


			   24                16                 8                 0
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	    |Y|Y|Y|Y|Y|Y|Y|M| |M|M|M|D|D|D|D|D| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s|
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	     \___________/\________/\_________/ \________/\____________/\_________/
		 year        month       day      hour       minute        second

The year is stored as an offset from 1980. Seconds are stored in two-second increments. (So if the "second" value is 15, it actually represents 30 seconds.)

GetAsIso8601

# formatStr is a string
# bLocal is a boolean
# outStr is a CkString (output)
status = ckDateTime.GetAsIso8601(formatStr, bLocal, outStr);
retStr = ckDateTime.getAsIso8601(formatStr, bLocal);

Introduced in version 9.5.0.65

Returns the date/time in a compatible ISO 8601 format according to the format specified in formatStr.. Examples of ISO 8601 formats include the following:

    YYYY-MM-DD

    YYYY-MM-DDThh:mmTZD

    YYYY-MM-DDThh:mm:ssTZD

For the date portion of these formats, YYYY is a four-digit year representation, MM is a two-digit month representation, and DD is a two-digit day representation. For the time portion, hh is the hour representation in 24-hour notation, mm is the two-digit minute representation, and ss is the two-digit second representation. A time designator T separates the date and time portions of the string, while a time zone designator TZD specifies a time zone (UTC).

bLocal indicates whether a local or UTC time is returned.

Note: The bLocal argument is interpreted as the reverse of what is intended . The problem was discovered just after releasing v9.5.0.65. It will be fixed in the next version update.

Returns true for success, false for failure.

More Information and Examples

DateTime - Get in ISO 8601 Compatible Format

GetAsOleDate

# bLocal is a boolean
retDouble = ckDateTime.GetAsOleDate(bLocal);

Returns the date/time in a Windows OLE "DATE" format.

bLocal indicates whether a local or UTC time is returned.

The OLE automation date format is a floating point value, counting days since midnight 30 December 1899. Hours and minutes are represented as fractional days.

GetAsRfc822

# bLocal is a boolean
# outStr is a CkString (output)
status = ckDateTime.GetAsRfc822(bLocal, outStr);
retStr = ckDateTime.getAsRfc822(bLocal);

Returns the date/time as an RFC822 formatted string. (An RFC822 format string is what is found in the "Date" header field of an email, such as "Wed, 18 Oct 2017 09:08:21 GMT".)

bLocal indicates whether a local or UTC time is returned.

Returns true for success, false for failure.

GetAsTimestamp

# bLocal is a boolean
# outStr is a CkString (output)
status = ckDateTime.GetAsTimestamp(bLocal, outStr);
retStr = ckDateTime.getAsTimestamp(bLocal);

Introduced in version 9.5.0.58

Returns the date/time as an RFC 3339 formatted string, such as "1990-12-31T23:59:60Z". (This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

bLocal indicates whether a local or UTC time is returned.

Returns true for success, false for failure.

More Information and Examples

Get Current Date/Time as Timestamp (YYYY-MM-DDThh:mm:ssTZD)

GetAsUnixTime

# bLocal is a boolean
retInt = ckDateTime.GetAsUnixTime(bLocal);

Returns the date/time as a 32-bit Unix time.

bLocal indicates whether the date/time returned is local or UTC.

Note: With this format, there is a Y2038 problem that pertains to 32-bit signed integers. There are approx 31.5 million seconds per year. The Unix time is number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). In 2012, it's 42 years since 1/1/1970, so the number of seconds is approx 1.3 billion. A 32-bit signed integer ranges from -2,147,483,648 to 2,147,483,647 Therefore, if a 32-bit signed integer is used, it turns negative in 2038.

The GetAsUnixTime64 and GetAsUnixTimeDbl methods are provided as solutions to the Y2038 problem.

(Note: The ActiveX Chilkat implementation omits methods that use 64-bit integers because there is no means for passing or returning 64-bit integers in ActiveX.)

GetAsUnixTime64

# bLocal is a boolean
retInt64 = ckDateTime.GetAsUnixTime64(bLocal);

The same as GetUnixTime, except returns the date/time as a 64-bit integer.

bLocal indicates whether a local or UTC time is returned.

GetAsUnixTimeDbl

# bLocal is a boolean
retDouble = ckDateTime.GetAsUnixTimeDbl(bLocal);

The same as GetUnixTime, except returns the date/time as a double.

bLocal indicates whether a local or UTC time is returned.

GetAsUnixTimeStr

# bLocal is a boolean
# outStr is a CkString (output)
status = ckDateTime.GetAsUnixTimeStr(bLocal, outStr);
retStr = ckDateTime.getAsUnixTimeStr(bLocal);

Introduced in version 9.5.0.65

Returns the time in Unix format (in seconds since the epoch: 00:00:00 UTC on 1 January 1970).

bLocal indicates whether the date/time returned is local or UTC.

Returns true for success, false for failure.

More Information and Examples

DateTime - Get as Unix Time String

GetDosDateHigh

# bLocal is a boolean
retInt = ckDateTime.GetDosDateHigh(bLocal);

Returns the high-order 16-bit integer of the date/time in DOS format. (See GetAsDosDate for more information.)

GetDosDateLow

# bLocal is a boolean
retInt = ckDateTime.GetDosDateLow(bLocal);

Returns the low-order 16-bit integer of the date/time in DOS format. (See GetAsDosDate for more information.)

GetDtObj

# returns a CkDtObj
# bLocal is a boolean
ret_dtObj = ckDateTime.GetDtObj(bLocal);

Introduced in version 9.5.0.47

Gets the date/time as a Chilkat "Dt" object.

Returns nil on failure

More Information and Examples

Get Email Date/Time

LoadTaskResult

# task is a CkTask
status = ckDateTime.LoadTaskResult(task);

Introduced in version 9.5.0.52

Loads the date/time from a completed asynchronous task.

Returns true for success, false for failure.

OlderThan

# n is an integer
# units is a string
retBool = ckDateTime.OlderThan(n, units);

Introduced in version 9.5.0.67

Returns true if the date/time is older than the current system date/time by n seconds/minutes/hours/days. Otherwise returns false. The units can be "seconds", "minutes", "hours", or "days" (plural or singular).

More Information and Examples

Date/Time Older-Than N Seconds/Minutes/Hours/Days

Serialize

# outStr is a CkString (output)
status = ckDateTime.Serialize(outStr);
retStr = ckDateTime.serialize();

Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1 or 0.

Returns true for success, false for failure.

SetFromCurrentSystemTime

retBool = ckDateTime.SetFromCurrentSystemTime();

Sets the date/time from the current system time.

SetFromDateTimeTicks

# bLocal is a boolean
# ticks is a 64-bit integer
retBool = ckDateTime.SetFromDateTimeTicks(bLocal, ticks);

Sets the date/time from a .NET DateTime value represented in ticks. See GetAsDateTimeTicks for more information.

bLocal indicates whether the passed in date/time is local or UTC.

SetFromDosDate

# bLocal is a boolean
# t is an integer
retBool = ckDateTime.SetFromDosDate(bLocal, t);

Sets the date/time from a 32-bit DOS date/time bitmask. See GetAsDosDate for more information.

SetFromDosDate2

# bLocal is a boolean
# datePart is an integer
# timePart is an integer
retBool = ckDateTime.SetFromDosDate2(bLocal, datePart, timePart);

Sets the date/time from two 16-bit integers representing the high and low words of a 32-bit DOS date/time bitmask. See GetAsDosDate for more information.

bLocal indicates whether the passed in date/time is local or UTC.

SetFromDtObj

# dt is a CkDtObj
status = ckDateTime.SetFromDtObj(dt);

Introduced in version 9.5.0.47

Sets the date/time from a Chilkat "Dt" object.

Returns true for success, false for failure.

SetFromNtpServer

# jsonStr is a string
status = ckDateTime.SetFromNtpServer(jsonStr);

Introduced in version 9.5.0.96

Sets the date/time by sending a query to an NTP server.

Note: The SetFromNtpServer method is available starting in v9.5.0.96 for most Chilkat builds, but not all. If the SetFromNtpServer method is not present, contact support@chilkatsoft.com for a hotfix build. It should be available in all programming languages/platforms starting in v9.5.0.97

Returns true for success, false for failure.

More Information and Examples

Query NTP Server for Current Date/Time

SetFromNtpTime

# ntpSeconds is an integer
retBool = ckDateTime.SetFromNtpTime(ntpSeconds);

Introduced in version 9.5.0.50

Sets the date/time from a 32-bit NTP time value. ntpSeconds is the number of seconds since 00:00 (midnight) 1 January 1900 GMT.

SetFromOleDate

# bLocal is a boolean
# dt is a double
retBool = ckDateTime.SetFromOleDate(bLocal, dt);

Sets the date/time from a Windows OLE "DATE" value.

bLocal indicates whether the passed in date/time is local or UTC.

Note: This method was not working correctly. The problem was discovered just after releasing v9.5.0.65. It will be fixed in the next version update.

SetFromRfc822

# rfc822Str is a string
status = ckDateTime.SetFromRfc822(rfc822Str);

Sets the date/time from an RFC822 date/time formatted string. Here are some examples of RFC822 formatted date/times:

Tue, 15 Nov 2022 22:00:58 +0000
Tue, 15 Nov 2022 20:21:50 +0100
Tue, 01 Nov 2022 18:09:41 -0600

Returns true for success, false for failure.

SetFromTimestamp

# timestamp is a string
status = ckDateTime.SetFromTimestamp(timestamp);

Introduced in version 9.5.0.58

Sets the date/time from an RFC 3339 timestamp format. (such as "1990-12-31T23:59:60Z:")

(This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

Note: Starting in v9.5.0.77, strings formatted as "YYMMDDhhmmssZ", such as "181221132225Z", can also be passed to this method.

Returns true for success, false for failure.

More Information and Examples

How to Parse a TimeStamp (such as 2016-11-11T14:32:17.0908971Z)

SetFromUlid

# bLocal is a boolean
# ulid is a string
status = ckDateTime.SetFromUlid(bLocal, ulid);

Introduced in version 9.5.0.94

Sets this object's date/time using the timestamp embedded in the ulid. If the ulid was not a valid ULID, returns false and the date/time is not set. bLocal indicates whether the ulid uses a local time or UTC time.

Returns true for success, false for failure.

More Information and Examples

Extract Timestamp from ULID

SetFromUnixTime

# bLocal is a boolean
# t is an integer
retBool = ckDateTime.SetFromUnixTime(bLocal, t);

Sets the date/time from a 32-bit UNIX time value. (See GetAsUnixTime for information about the Y2038 problem.)

bLocal indicates whether the passed in date/time is local or UTC.

SetFromUnixTime64

# bLocal is a boolean
# t is a 64-bit integer
retBool = ckDateTime.SetFromUnixTime64(bLocal, t);

The same as SetFromUnixTime, except that it uses a 64-bit integer to solve the Y2038 problem. (See GetAsUnixTime for more information about Y2038).

bLocal indicates whether the passed in date/time is local or UTC.

SetFromUnixTimeDbl

# bLocal is a boolean
# d is a double
retBool = ckDateTime.SetFromUnixTimeDbl(bLocal, d);

The same as SetFromUnixTime, except that it uses a double to solve the Y2038 problem. (See GetAsUnixTime for more information about Y2038).

bLocal indicates whether the passed in date/time is local or UTC.

UlidGenerate

# bLocal is a boolean
# outStr is a CkString (output)
status = ckDateTime.UlidGenerate(bLocal, outStr);
retStr = ckDateTime.ulidGenerate(bLocal);

Introduced in version 9.5.0.94

Generates and returns a new ULID using this object's date/time value. bLocal indicates whether to use local time or UTC time.

Returns true for success, false for failure.

More Information and Examples

UlidIncrement

# ulid is a CkStringBuilder
retBool = ckDateTime.UlidIncrement(ulid);

Introduced in version 9.5.0.94

Increments the ULID that is passed in ulid.

More Information and Examples

Generate Monotonic ULIDs

UlidValidate

# ulid is a string
status = ckDateTime.UlidValidate(ulid);

Introduced in version 9.5.0.94

Validates the ulid. Returns true if the ulid is valid, otherwise returns false.

Returns true for success, false for failure.

More Information and Examples

Validate a ULID