DtObj PureBasic Reference Documentation

DtObj

Current Version: 10.1.2

Object Creation

obj.i = CkDtObj::ckCreate()

; Make sure to dispose of the object when finished like this:
CkDtObj::ckDispose(obj);

Properties

Day
Declare.i ckDay(obj.i)
Declare setCkDay(obj.i, value.i)

The day of the month. The valid values for this member are 1 through 31.

top
DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
Hour
Declare.i ckHour(obj.i)
Declare setCkHour(obj.i, value.i)

The hour. The valid values for this member are 0 through 23.

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
Minute
Declare.i ckMinute(obj.i)
Declare setCkMinute(obj.i, value.i)

The minute. The valid values for this member are 0 through 59.

top
Month
Declare.i ckMonth(obj.i)
Declare setCkMonth(obj.i, value.i)

The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.

top
Second
Declare.i ckSecond(obj.i)
Declare setCkSecond(obj.i, value.i)

The second. The valid values for this member are 0 through 59.

top
StructTmMonth
Declare.i ckStructTmMonth(obj.i)
Declare setCkStructTmMonth(obj.i, value.i)

The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.

top
StructTmYear
Declare.i ckStructTmYear(obj.i)
Declare setCkStructTmYear(obj.i, value.i)

The year represented as the number of years since 1900.

top
Utc
Declare.i ckUtc(obj.i)
Declare setCkUtc(obj.i, value.i)

1 if this is a UTC time, otherwise 0 if this is a local time.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples
How to get the Chilkat version at runtime.
top
Year
Declare.i ckYear(obj.i)
Declare setCkYear(obj.i, value.i)

The year, such as 2012.

top

Methods

DeSerialize
Declare ckDeSerialize(obj.i, serializedDtObj.s)

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.

top
Serialize
Declare.s ckSerialize(obj.i)

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/0.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

top