ThinBASIC Core Language > Data Structures > cOptions > cOptions Methods

Description

Set KeyName/Value pairs inside a cOptions object.

Syntax

<cOptions>.Set( KeyName: Value [, KeyName: Value [, ...]])

Returns

None

Parameters

Name

Type

Optional

Meaning

KeyName

Any sequence of chars will be recognized as key name.

Special chars can be used as part of the key name: \ and . (point)

KeyName will always internally converted into capital letters. If you need to keep the KeyName as typed, please include it into double quoted string.

Value

String

Any expression that will be converted into string before assigning to the key

Remarks

cOptions object will NOT be erased before parsing new KeyName/Value pairs like in <cOptions>.Init.

If KeyName is already present, its value will be updated.

If KeyName is not present, a new key will be added.

Like in Javascript, the last property in the list may end with a comma:

dim User as new cOptions
User.Set (
name: "John",
age: 30,
)

That is called a “trailing” or “hanging” comma. Makes it easier to add/remove/move around properties, because all lines become alike.

Restrictions

See also

Examples

dim ExportCsvOpt as new cOptions
ExportCsvOpt.Set(
                    Filename: APP_SourcePath + "ADODB_Erbolario_Test_Export_Out.csv",
                    ColumnNames: %TRUE,
                    FieldSeparator: ";",
                    RecordSeparator: $crlf,
                    StringDelimiter: $dq,
                    DecimalSeparator: ".",
                    RecordBuffer: 1000,
                    Index: %TRUE,
                    IndexBase: 1,
                    MaxRecords: -1,
                    Replace_CR: %TRUE,
                    Replace_CR_Char: "",
                    Replace_LF: %TRUE,
                    Replace_LF_Char: "",
                    Replace_CRLF: %TRUE,
                    Replace_CRLF_Char: "",
                    Replace_DQ: %TRUE,
                    Replace_DQ_Char: "'"
                  )