Csv Unicode C Reference Documentation

Csv

Create/Dispose

HCkCsvW CkCsvW_Create(void);

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

void CkCsvW_Dispose(HCkCsvW handle);

Objects created by calling CkCsvW_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 CkCsvW_Dispose.

Properties

BOOL CkCsvW_getAutoTrim(HCkCsvW cHandle);

void CkCsvW_putAutoTrim(HCkCsvW cHandle, BOOL newVal);

If TRUE, then the strings returned by GetCell and GetCellByName are auto-trimmed of whitespace from both ends.

BOOL CkCsvW_getCrlf(HCkCsvW cHandle);

void CkCsvW_putCrlf(HCkCsvW cHandle, BOOL newVal);

If TRUE, then CRLF line endings are used when saving the CSV to a file or to a string (i.e. for the methods SaveFile, SaveFile2, SaveToString). If FALSE then bare LF line-endings are used.

void CkCsvW_getDebugLogFilePath(HCkCsvW cHandle, HCkString retval);

void CkCsvW_putDebugLogFilePath(HCkCsvW cHandle, const wchar_t *newVal);

const wchar_t *CkCsvW_debugLogFilePath(HCkCsvW 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.

void CkCsvW_getDelimiter(HCkCsvW cHandle, HCkString retval);

void CkCsvW_putDelimiter(HCkCsvW cHandle, const wchar_t *newVal);

const wchar_t *CkCsvW_delimiter(HCkCsvW cHandle);

The character that separates fields in a record. It is a comma by default. If the Delimiter property is not explicitly set, the CSV component will detect the delimiter when loading a CSV. (Semicolons are typically used in locales where the comma is used as a decimal point.)

BOOL CkCsvW_getEnableQuotes(HCkCsvW cHandle);

void CkCsvW_putEnableQuotes(HCkCsvW cHandle, BOOL newVal);

Introduced in version 9.5.0.71

If TRUE, then the double-quote characters cause the quoted content, including CR's, LF's, and delimiter chars to be treated as normal text when reading/writing CSVs. The default is TRUE.

BOOL CkCsvW_getEscapeBackslash(HCkCsvW cHandle);

void CkCsvW_putEscapeBackslash(HCkCsvW cHandle, BOOL newVal);

Introduced in version 9.5.0.44

If TRUE, then the backslash character is treated as an escape character when reading/writing CSVs. The default is FALSE.

BOOL CkCsvW_getHasColumnNames(HCkCsvW cHandle);

void CkCsvW_putHasColumnNames(HCkCsvW cHandle, BOOL newVal);

Set to TRUE prior to loading a CSV if the 1st record contains column names. This allows the CSV parser to correctly load the column names and not treat them as data.

void CkCsvW_getLastErrorHtml(HCkCsvW cHandle, HCkString retval);

const wchar_t *CkCsvW_lastErrorHtml(HCkCsvW 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.

void CkCsvW_getLastErrorText(HCkCsvW cHandle, HCkString retval);

const wchar_t *CkCsvW_lastErrorText(HCkCsvW 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.

Concept of LastErrorText

LastErrorText Standard Information

void CkCsvW_getLastErrorXml(HCkCsvW cHandle, HCkString retval);

const wchar_t *CkCsvW_lastErrorXml(HCkCsvW 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.

BOOL CkCsvW_getLastMethodSuccess(HCkCsvW cHandle);

void CkCsvW_putLastMethodSuccess(HCkCsvW 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.

int CkCsvW_getNumColumns(HCkCsvW cHandle);

The number of columns in the 1st row, which may be the row containing column names if HasColumnNames is TRUE.

int CkCsvW_getNumRows(HCkCsvW cHandle);

The number of data rows. If the CSV has column names, the 1st row is not included in the count. Also, empty lines containing only whitespace characters that follow the last non-empty row are not included.

BOOL CkCsvW_getVerboseLogging(HCkCsvW cHandle);

void CkCsvW_putVerboseLogging(HCkCsvW 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.

void CkCsvW_getVersion(HCkCsvW cHandle, HCkString retval);

const wchar_t *CkCsvW_version(HCkCsvW cHandle);

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

Methods

BOOL CkCsvW_DeleteColumn(HCkCsvW cHandle, int index);

Deletes the Nth column. (The 1st column is at index 0.)

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_DeleteColumnByName(HCkCsvW cHandle, const wchar_t *columnName);

Deletes a column specified by name.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_DeleteRow(HCkCsvW cHandle, int index);

Deletes the entire Nth row. (The 1st row is at index 0.)

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_GetCell(HCkCsvW cHandle, int row, int col, const wchar_t *outStr);

const wchar_t *CkCsvW_getCell(HCkCsvW cHandle, int row, int col);

Returns the contents of the cell at row, col. Indexing begins at 0. (The topmost/leftmost cell is at 0,0)

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_GetCellByName(HCkCsvW cHandle, int rowIndex, const wchar_t *columnName, const wchar_t *outStr);

const wchar_t *CkCsvW_getCellByName(HCkCsvW cHandle, int rowIndex, const wchar_t *columnName);

The same as GetCell, but the column is specified by name instead of by index.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_GetColumnName(HCkCsvW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkCsvW_getColumnName(HCkCsvW cHandle, int index);

Returns the name of the Nth column.

Returns TRUE for success, FALSE for failure.

int CkCsvW_GetIndex(HCkCsvW cHandle, const wchar_t *columnName);

Returns the column index for a given column.

int CkCsvW_GetNumCols(HCkCsvW cHandle, int row);

Returns the number of columns for a specific row. If the row is larger than the number of rows in the CSV, a zero is returned.

BOOL CkCsvW_LoadFile(HCkCsvW cHandle, const wchar_t *path);

Loads a CSV from a file. It is assumed that the CSV file contains ANSI characters.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_LoadFile2(HCkCsvW cHandle, const wchar_t *filename, const wchar_t *charset);

Loads a CSV from a file. The charset specifies the character encoding of the CSV file. A list of supported character encodings may be found on this page: Supported Charsets.

Returns TRUE for success, FALSE for failure.

Read Japanese utf-8 CSV File

BOOL CkCsvW_LoadFromString(HCkCsvW cHandle, const wchar_t *csvData);

Loads a CSV document from an in-memory string variable.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_RowMatches(HCkCsvW cHandle, int rowIndex, const wchar_t *matchPattern, BOOL caseSensitive);

Compares the contents of an entire row to a wildcarded match pattern where "*" can be used any number of times to match 0 or more of any character. Returns TRUE if a match was found, otherwise returns FALSE. If caseSensitive is TRUE, then the pattern match is case sensitive, otherwise it is case insensitive.

BOOL CkCsvW_SaveFile(HCkCsvW cHandle, const wchar_t *path);

Saves a CSV to a file. The output file is written using the ANSI character encoding.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SaveFile2(HCkCsvW cHandle, const wchar_t *filename, const wchar_t *charset);

Saves a CSV to a file. The charset specifies the character encoding to use for the CSV file. The text data is converted to this charset when saving. A list of supported character encodings may be found on this page: Supported Charsets.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SaveLastError(HCkCsvW 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.

BOOL CkCsvW_SaveToString(HCkCsvW cHandle, const wchar_t *outStr);

const wchar_t *CkCsvW_saveToString(HCkCsvW cHandle);

Writes the entire CSV document to a string variable.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SetCell(HCkCsvW cHandle, int row, int col, const wchar_t *content);

Sets the contents for a single cell in the CSV. The content may include any characters including CRLF's, double-quotes, and the delimiter character. The Save* methods automatically double-quote fields with special chars when saving. The Load* methods automatically parse double-quoted and/or escaped fields correctly when loading.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SetCellByName(HCkCsvW cHandle, int rowIndex, const wchar_t *columnName, const wchar_t *contentStr);

The same as SetCell, except the column is specified by name instead of by index.

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SetColumnName(HCkCsvW cHandle, int index, const wchar_t *columnName);

Sets the name of the Nth column. The first column is at index 0. This method would only return FALSE if an invalid index is passed (such as a negative number).

Returns TRUE for success, FALSE for failure.

BOOL CkCsvW_SortByColumn(HCkCsvW cHandle, const wchar_t *columnName, BOOL ascending, BOOL caseSensitive);

Sorts the rows in the CSV by the contents of a specific column. If ascending is TRUE, the sort is in ascending order, otherwise descending order. If caseSensitive is TRUE then the sorting is case sensitive.

Returns TRUE for success, FALSE for failure.