CkStringArray Reference

Certificate • Crypt • XML • Mail • S/MIME • Zip • XMsg • SSL • RTC • Charset
CkStringArray • CkData • ChilkatCSP

This control is part of the Chilkat Util ActiveX, which is included with any product that uses it.

Properties

Count As Long read-only

The number of strings in the array.

Crlf As Boolean read/write

If TRUE, strings are always automatically converted to use CRLF line endings. If FALSE, strings are automatically converted to use bare LF line endings.

 

Trim As Boolean read/write

If TRUE, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the array.

Unique As Boolean read/write

If TRUE, the array does not allow duplicates. When an attempt is made to insert a string that already exists in the array, the insertion simply doesn't happen and no error is returned.

Methods

Append(str As String)

Appends a string to the end of the array.

 

AppendSerialized(encodedStrings As String)

Appends multiple strings to the end of the array. The encodedStrings argument is what is returned from the Serialize method (see below).

 

Clear()

Remove all strings from the array.

 

Contains(str As String) As Boolean

Returns TRUE if the string is present in the array. The string comparisons are case sensitive.

 

Find(str As String, beginIndex as Long) As Long

Finds the index of the first string equal to the string passed. The search begins at beginIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.

GetString(index as Long) As String

Returns the string at a location in the array. The first string is at index 0.

InsertAt(index as Long, str As String)

Insert a string into the array at a particular index. Using index 0 will insert at the beginning.

LastString() As String

Returns the last string in the array.

 

LoadFromFile(filename As String) As Long

Adds strings from a file (one per line) into the string array. Returns 1 for success, 0 for failure.

 

Pop() As String

Returns the last string and removes it from the array.

 

Prepend(str As String)

Adds a string to the beginning of the array.

Remove(str As String)

Removes all strings equal to the string argument from the array.

 

RemoveAt(index as Long)

Removes the string at a particular index.

SaveToFile(filename As String) As Long

Saves the array of strings to a file, one string per line. Returns 1 if successful, 0 if not.

 

Serialize() As String

Returns an string which is an encoded representation of all the strings in the array. The StringArray can be re-created by calling the AppendSerialized method. One reason this method exists is to make it easy to pass entire string arrays as a form parameter in a Web page.