DtObj Unicode C Reference Documentation

DtObj

Current Version: 9.5.0.73

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.

top
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, 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
int CkDtObjW_getHour(HCkDtObjW cHandle);
void CkDtObjW_putHour(HCkDtObjW cHandle, int newVal);

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

top
LastErrorHtml
void CkDtObjW_getLastErrorHtml(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorHtml(HCkDtObjW 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.

top
LastErrorText
void CkDtObjW_getLastErrorText(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorText(HCkDtObjW 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.

top
LastErrorXml
void CkDtObjW_getLastErrorXml(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_lastErrorXml(HCkDtObjW 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.

top
LastMethodSuccess
BOOL CkDtObjW_getLastMethodSuccess(HCkDtObjW cHandle);
void CkDtObjW_putLastMethodSuccess(HCkDtObjW cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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.

top
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.

top
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.

top
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.

top
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.

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

The year represented as the number of years since 1900.

top
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.

top
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.

top
Version
void CkDtObjW_getVersion(HCkDtObjW cHandle, HCkString retval);
const wchar_t *CkDtObjW_version(HCkDtObjW cHandle);

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

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

The year, such as 2012.

top

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.

top
SaveLastError
BOOL CkDtObjW_SaveLastError(HCkDtObjW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top
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.

top