CkCsvW Unicode C++ Reference Documentation

CkCsvW

Current Version: 9.5.0.73

Object Creation

// Local variable on the stack
CkCsvW obj;

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

Properties

AutoTrim
bool get_AutoTrim(void);
void put_AutoTrim(bool newVal);

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

top
Crlf
bool get_Crlf(void);
void put_Crlf(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.

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

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
Delimiter
void get_Delimiter(CkString &str);
const wchar_t *delimiter(void);
void put_Delimiter(const wchar_t *str);

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

top
EnableQuotes
bool get_EnableQuotes(void);
void put_EnableQuotes(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.

top
EscapeBackslash
bool get_EscapeBackslash(void);
void put_EscapeBackslash(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.

top
HasColumnNames
bool get_HasColumnNames(void);
void put_HasColumnNames(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.

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

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

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

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 get_LastMethodSuccess(void);
void put_LastMethodSuccess(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
NumColumns
int get_NumColumns(void);

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

top
NumRows
int get_NumRows(void);

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.

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 wchar_t *version(void);

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

top

Methods

DeleteColumn
bool DeleteColumn(int index);

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

Returns true for success, false for failure.

top
DeleteColumnByName
bool DeleteColumnByName(const wchar_t *columnName);

Deletes a column specified by name.

Returns true for success, false for failure.

top
DeleteRow
bool DeleteRow(int index);

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

Returns true for success, false for failure.

top
GetCell
bool GetCell(int row, int col, CkString &outStr);
const wchar_t *getCell(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.

top
GetCellByName
bool GetCellByName(int rowIndex, const wchar_t *columnName, CkString &outStr);
const wchar_t *getCellByName(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.

top
GetColumnName
bool GetColumnName(int index, CkString &outStr);
const wchar_t *getColumnName(int index);

Returns the name of the Nth column.

Returns true for success, false for failure.

top
GetIndex
int GetIndex(const wchar_t *columnName);

Returns the column index for a given column.

top
GetNumCols
int GetNumCols(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.

top
LoadFile
bool LoadFile(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.

top
LoadFile2
bool LoadFile2(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.

More Information and Examples
top
LoadFromString
bool LoadFromString(const wchar_t *csvData);

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

Returns true for success, false for failure.

top
RowMatches
bool RowMatches(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.

top
SaveFile
bool SaveFile(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.

top
SaveFile2
bool SaveFile2(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.

top
SaveLastError
bool SaveLastError(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
SaveToString
bool SaveToString(CkString &outStr);
const wchar_t *saveToString(void);

Writes the entire CSV document to a string variable.

Returns true for success, false for failure.

top
SetCell
bool SetCell(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.

top
SetCellByName
bool SetCellByName(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.

top
SetColumnName
bool SetColumnName(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.

top
SortByColumn
bool SortByColumn(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.

top