CkDtObj Perl Reference Documentation

CkDtObj

Current Version: 9.5.0.73

Object Creation

$obj = chilkat::CkDtObj()->new();

Properties

Day
# $intVal is an integer
$intVal = $dtObj->get_Day();
$dtObj->put_Day($intVal);

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

top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$dtObj->get_DebugLogFilePath($ckStr);
$strVal = $dtObj->debugLogFilePath();
$dtObj->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:

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

top
Hour
# $intVal is an integer
$intVal = $dtObj->get_Hour();
$dtObj->put_Hour($intVal);

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

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$dtObj->get_LastErrorHtml($ckStr);
$strVal = $dtObj->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.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$dtObj->get_LastErrorText($ckStr);
$strVal = $dtObj->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.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$dtObj->get_LastErrorXml($ckStr);
$strVal = $dtObj->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.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $dtObj->get_LastMethodSuccess();
$dtObj->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Minute
# $intVal is an integer
$intVal = $dtObj->get_Minute();
$dtObj->put_Minute($intVal);

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

top
Month
# $intVal is an integer
$intVal = $dtObj->get_Month();
$dtObj->put_Month($intVal);

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

top
Second
# $intVal is an integer
$intVal = $dtObj->get_Second();
$dtObj->put_Second($intVal);

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

top
StructTmMonth
# $intVal is an integer
$intVal = $dtObj->get_StructTmMonth();
$dtObj->put_StructTmMonth($intVal);

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

top
StructTmYear
# $intVal is an integer
$intVal = $dtObj->get_StructTmYear();
$dtObj->put_StructTmYear($intVal);

The year represented as the number of years since 1900.

top
Utc
# $boolVal is a boolean
$boolVal = $dtObj->get_Utc();
$dtObj->put_Utc($boolVal);

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

top
Utf8
# $boolVal is a boolean
$boolVal = $dtObj->get_Utf8();
$dtObj->put_Utf8($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
# $boolVal is a boolean
$boolVal = $dtObj->get_VerboseLogging();
$dtObj->put_VerboseLogging($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
# $strVal is a string
# $ckStr is a CkString
$dtObj->get_Version($ckStr);
$strVal = $dtObj->version();

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

top
Year
# $intVal is an integer
$intVal = $dtObj->get_Year();
$dtObj->put_Year($intVal);

The year, such as 2012.

top

Methods

DeSerialize
# $serializedDtObj is a string
$dtObj->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
SaveLastError
# $path is a string
$status = $dtObj->SaveLastError($path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
Serialize
# $outStr is a CkString (output)
$status = $dtObj->Serialize($outStr);
$retStr = $dtObj->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/0.

Returns 1 for success, 0 for failure.

top