DtObj Tcl Reference Documentation

DtObj

Current Version: 10.1.2

Object Creation

set myDtObj [new CkDtObj]

Properties

Day
integer
set intVal [CkDtObj_get_Day $myDtObj]
CkDtObj_put_Day $myDtObj $intVal

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

top
DebugLogFilePath
string
# ckStr is a CkString
CkDtObj_get_DebugLogFilePath $myDtObj $ckStr
set strVal [CkDtObj_get_debugLogFilePath $myDtObj]
CkDtObj_put_DebugLogFilePath $myDtObj $strVal

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
top
Hour
integer
set intVal [CkDtObj_get_Hour $myDtObj]
CkDtObj_put_Hour $myDtObj $intVal

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

top
LastErrorHtml
string
# ckStr is a CkString
CkDtObj_get_LastErrorHtml $myDtObj $ckStr
set strVal [CkDtObj_get_lastErrorHtml $myDtObj]

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
string
# ckStr is a CkString
CkDtObj_get_LastErrorText $myDtObj $ckStr
set strVal [CkDtObj_get_lastErrorText $myDtObj]

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.

top
LastErrorXml
string
# ckStr is a CkString
CkDtObj_get_LastErrorXml $myDtObj $ckStr
set strVal [CkDtObj_get_lastErrorXml $myDtObj]

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
boolean 1/0
set boolVal [CkDtObj_get_LastMethodSuccess $myDtObj]
CkDtObj_put_LastMethodSuccess $myDtObj $boolVal

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
integer
set intVal [CkDtObj_get_Minute $myDtObj]
CkDtObj_put_Minute $myDtObj $intVal

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

top
Month
integer
set intVal [CkDtObj_get_Month $myDtObj]
CkDtObj_put_Month $myDtObj $intVal

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

top
Second
integer
set intVal [CkDtObj_get_Second $myDtObj]
CkDtObj_put_Second $myDtObj $intVal

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

top
StructTmMonth
integer
set intVal [CkDtObj_get_StructTmMonth $myDtObj]
CkDtObj_put_StructTmMonth $myDtObj $intVal

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

top
StructTmYear
integer
set intVal [CkDtObj_get_StructTmYear $myDtObj]
CkDtObj_put_StructTmYear $myDtObj $intVal

The year represented as the number of years since 1900.

top
Utc
boolean 1/0
set boolVal [CkDtObj_get_Utc $myDtObj]
CkDtObj_put_Utc $myDtObj $boolVal

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

top
Utf8
boolean 1/0
set boolVal [CkDtObj_get_Utf8 $myDtObj]
CkDtObj_put_Utf8 $myDtObj $boolVal

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

top
VerboseLogging
boolean 1/0
set boolVal [CkDtObj_get_VerboseLogging $myDtObj]
CkDtObj_put_VerboseLogging $myDtObj $boolVal

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
string
# ckStr is a CkString
CkDtObj_get_Version $myDtObj $ckStr
set strVal [CkDtObj_get_version $myDtObj]

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

More Information and Examples
top
Year
integer
set intVal [CkDtObj_get_Year $myDtObj]
CkDtObj_put_Year $myDtObj $intVal

The year, such as 2012.

top

Methods

DeSerialize
# serializedDtObj is a string
CkDtObj_DeSerialize $serializedDtObj

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
# outStr is a CkString (output)
set status [CkDtObj_Serialize $outStr]
set retStr [CkDtObj_serialize $myDtObj]

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 1 for success, 0 for failure.

top