CkoStringTable Objective-C Reference Documentation

CkoStringTable

A memory efficient class for holding a large number of strings (accessible by index). The primary use is as a read-only table of strings that is built once and then used by the application.

This class is introduced in Chilkat v9.5.0.62.

Properties

@property (nonatomic, readonly, copy) NSNumber *Count;

Introduced in version 9.5.0.62

The number of strings in the table.

@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

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.

@property (nonatomic, readonly, copy) NSString *LastErrorText;

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

@property (nonatomic, readonly, copy) NSString *LastErrorXml;

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.

@property (nonatomic) BOOL LastMethodSuccess;

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO 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 = YES and failure = NO.
  • 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 YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

@property (nonatomic, readonly, copy) NSString *Version;

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

Methods

- (BOOL)Append:(NSString *)value;

Introduced in version 9.5.0.62

Appends a string to the table.

Returns YES for success, NO for failure.

- (BOOL)AppendFromFile:(NSNumber *)maxLineLen
    charset:(NSString *)charset
    path:(NSString *)path;

Introduced in version 9.5.0.62

Appends strings, one per line, from a file. Each line in the path should be no longer than the length specified in maxLineLen. The charset indicates the character encoding of the contents of the file, such as "utf-8", "iso-8859-1", "Shift_JIS", etc.

Returns YES for success, NO for failure.

- (BOOL)AppendFromSb:(CkoStringBuilder *)sb;

Introduced in version 9.5.0.62

Appends strings, one per line, from the contents of a StringBuilder object.

Returns YES for success, NO for failure.

- (void)Clear;

Introduced in version 9.5.0.62

Removes all the strings from the table.

- (BOOL)SaveLastError:(NSString *)path;

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

Returns YES for success, NO for failure.

- (BOOL)SaveToFile:(NSString *)charset
    bCrlf:(BOOL)bCrlf
    path:(NSString *)path;

Introduced in version 9.5.0.62

Saves the string table to a file. The charset is the character encoding to use, such as "utf-8", "iso-8859-1", "windows-1252", "Shift_JIS", "gb2312", etc. If bCrlf is YES, then CRLF line endings are used, otherwise LF-only line endings are used.

Returns YES for success, NO for failure.

- (BOOL)SplitAndAppend:(NSString *)inStr
    delimiterChar:(NSString *)delimiterChar
    exceptDoubleQuoted:(BOOL)exceptDoubleQuoted
    exceptEscaped:(BOOL)exceptEscaped;

Introduced in version 9.5.0.62

Splits a string into parts based on a single character delimiterChar. If exceptDoubleQuoted is YES, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is YES, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns YES for success, NO for failure.

StringTable SplitAndAppend Example

- (NSString *)StringAt:(NSNumber *)index;

Introduced in version 9.5.0.62

Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)

Returns nil on failure