DtObj Unicode C Reference Documentation

DtObj

Current Version: 10.1.2

Create/Dispose

HCkDtObjW instance = CkDtObjW_Create();
// ...
CkDtObjW_Dispose(instance);

HCkDtObjW CkDtObjW_Create(void);

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

void CkDtObjW_Dispose(HCkDtObjW handle);

Objects created by calling CkDtObjW_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 CkDtObjW_Dispose.

Properties

Day

int CkDtObjW_getDay(HCkDtObjW cHandle);
void CkDtObjW_putDay(HCkDtObjW cHandle, int newVal);

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

DebugLogFilePath

void CkDtObjW_getDebugLogFilePath(HCkDtObjW cHandle, HCkString retval);
void CkDtObjW_putDebugLogFilePath(HCkDtObjW cHandle, const wchar_t *newVal);
const wchar_t *CkDtObjW_debugLogFilePath(HCkDtObjW cHandle);

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.

Hour

int CkDtObjW_getHour(HCkDtObjW cHandle);
void CkDtObjW_putHour(HCkDtObjW cHandle, int newVal);

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

LastErrorHtml

void CkDtObjW_getLastErrorHtml(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorHtml(HCkDtObjW cHandle);

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.

LastErrorText

void CkDtObjW_getLastErrorText(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorText(HCkDtObjW cHandle);

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 LastErrorText LastErrorText Standard Information

LastErrorXml

void CkDtObjW_getLastErrorXml(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorXml(HCkDtObjW cHandle);

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.

LastMethodSuccess

BOOL CkDtObjW_getLastMethodSuccess(HCkDtObjW cHandle);
void CkDtObjW_putLastMethodSuccess(HCkDtObjW cHandle, 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.

Minute

int CkDtObjW_getMinute(HCkDtObjW cHandle);
void CkDtObjW_putMinute(HCkDtObjW cHandle, int newVal);

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

Month

int CkDtObjW_getMonth(HCkDtObjW cHandle);
void CkDtObjW_putMonth(HCkDtObjW cHandle, int newVal);

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

Second

int CkDtObjW_getSecond(HCkDtObjW cHandle);
void CkDtObjW_putSecond(HCkDtObjW cHandle, int newVal);

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

StructTmMonth

int CkDtObjW_getStructTmMonth(HCkDtObjW cHandle);
void CkDtObjW_putStructTmMonth(HCkDtObjW cHandle, int newVal);

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

StructTmYear

int CkDtObjW_getStructTmYear(HCkDtObjW cHandle);
void CkDtObjW_putStructTmYear(HCkDtObjW cHandle, int newVal);

The year represented as the number of years since 1900.

Utc

BOOL CkDtObjW_getUtc(HCkDtObjW cHandle);
void CkDtObjW_putUtc(HCkDtObjW cHandle, BOOL newVal);

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

VerboseLogging

BOOL CkDtObjW_getVerboseLogging(HCkDtObjW cHandle);
void CkDtObjW_putVerboseLogging(HCkDtObjW 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 CkDtObjW_getVersion(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_version(HCkDtObjW cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Year

int CkDtObjW_getYear(HCkDtObjW cHandle);
void CkDtObjW_putYear(HCkDtObjW cHandle, int newVal);

The year, such as 2012.

Methods

DeSerialize

void CkDtObjW_DeSerialize(HCkDtObjW cHandle, const wchar_t *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 CkDtObjW_Serialize(HCkDtObjW cHandle, const wchar_t *outStr);
const wchar_t *CkDtObjW_serialize(HCkDtObjW 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.