DtObj C++ Reference Documentation

CkDtObj

Current Version: 10.1.2

Object Creation

// Local variable on the stack
CkDtObj obj;

// Dynamically allocate/delete
CkDtObj *pObj = new CkDtObj();
// ...
delete pObj;

Properties

Day
int get_Day(void);
void put_Day(int newVal);

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

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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
int get_Hour(void);
void put_Hour(int newVal);

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

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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
void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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
void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Indicates the success or failure of the most recent method call: true means success, false 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
int get_Minute(void);
void put_Minute(int newVal);

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

top
Month
int get_Month(void);
void put_Month(int newVal);

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

top
Second
int get_Second(void);
void put_Second(int newVal);

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

top
StructTmMonth
int get_StructTmMonth(void);
void put_StructTmMonth(int newVal);

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

top
StructTmYear
int get_StructTmYear(void);
void put_StructTmYear(int newVal);

The year represented as the number of years since 1900.

top
Utc
bool get_Utc(void);
void put_Utc(bool newVal);

true if this is a UTC time, otherwise false if this is a local time.

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

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.

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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.

top
Version
void get_Version(CkString &str);
const char *version(void);

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

More Information and Examples
How to get the Chilkat version at runtime.
top
Year
int get_Year(void);
void put_Year(int newVal);

The year, such as 2012.

top

Methods

DeSerialize
void DeSerialize(const char *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
bool Serialize(CkString &outStr);
const char *serialize(void);

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 true for success, false for failure.

top