DtObj C Reference Documentation

DtObj

Current Version: 10.1.0

Create/Dispose

HCkDtObj instance = CkDtObj_Create();
// ...
CkDtObj_Dispose(instance);

HCkDtObj CkDtObj_Create(void);

Creates an instance of the HCkDtObj object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkDtObj_Dispose(HCkDtObj handle);

Objects created by calling CkDtObj_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkDtObj_Dispose.

Properties

Day

int CkDtObj_getDay(HCkDtObj cHandle);
void CkDtObj_putDay(HCkDtObj cHandle, int newVal);

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

DebugLogFilePath

void CkDtObj_getDebugLogFilePath(HCkDtObj cHandle, HCkString retval);
void CkDtObj_putDebugLogFilePath(HCkDtObj cHandle, const char *newVal);
const char *CkDtObj_debugLogFilePath(HCkDtObj cHandle);

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.

Hour

int CkDtObj_getHour(HCkDtObj cHandle);
void CkDtObj_putHour(HCkDtObj cHandle, int newVal);

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

LastErrorHtml

void CkDtObj_getLastErrorHtml(HCkDtObj cHandle, HCkString retval);
const char *CkDtObj_lastErrorHtml(HCkDtObj cHandle);

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

void CkDtObj_getLastErrorText(HCkDtObj cHandle, HCkString retval);
const char *CkDtObj_lastErrorText(HCkDtObj cHandle);

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

void CkDtObj_getLastErrorXml(HCkDtObj cHandle, HCkString retval);
const char *CkDtObj_lastErrorXml(HCkDtObj cHandle);

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

BOOL CkDtObj_getLastMethodSuccess(HCkDtObj cHandle);
void CkDtObj_putLastMethodSuccess(HCkDtObj cHandle, BOOL newVal);

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.

Minute

int CkDtObj_getMinute(HCkDtObj cHandle);
void CkDtObj_putMinute(HCkDtObj cHandle, int newVal);

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

Month

int CkDtObj_getMonth(HCkDtObj cHandle);
void CkDtObj_putMonth(HCkDtObj cHandle, int newVal);

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

Second

int CkDtObj_getSecond(HCkDtObj cHandle);
void CkDtObj_putSecond(HCkDtObj cHandle, int newVal);

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

StructTmMonth

int CkDtObj_getStructTmMonth(HCkDtObj cHandle);
void CkDtObj_putStructTmMonth(HCkDtObj cHandle, int newVal);

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

StructTmYear

int CkDtObj_getStructTmYear(HCkDtObj cHandle);
void CkDtObj_putStructTmYear(HCkDtObj cHandle, int newVal);

The year represented as the number of years since 1900.

Utc

BOOL CkDtObj_getUtc(HCkDtObj cHandle);
void CkDtObj_putUtc(HCkDtObj cHandle, BOOL newVal);

TRUE if this is a UTC time, otherwise FALSE if this is a local time.

Utf8

BOOL CkDtObj_getUtf8(HCkDtObj cHandle);
void CkDtObj_putUtf8(HCkDtObj cHandle, 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.

VerboseLogging

BOOL CkDtObj_getVerboseLogging(HCkDtObj cHandle);
void CkDtObj_putVerboseLogging(HCkDtObj cHandle, 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.

Version

void CkDtObj_getVersion(HCkDtObj cHandle, HCkString retval);
const char *CkDtObj_version(HCkDtObj cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Year

int CkDtObj_getYear(HCkDtObj cHandle);
void CkDtObj_putYear(HCkDtObj cHandle, int newVal);

The year, such as 2012.

Methods

DeSerialize

void CkDtObj_DeSerialize(HCkDtObj cHandle, 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.

Serialize

BOOL CkDtObj_Serialize(HCkDtObj cHandle, HCkString outStr);
const char *CkDtObj_serialize(HCkDtObj cHandle);

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.