Skip to content

Commit d7e50ac

Browse files
committed
Update docs
1 parent a5c4927 commit d7e50ac

File tree

9 files changed

+27
-27
lines changed

9 files changed

+27
-27
lines changed

docs/api/methods/dumptoarray.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ See also
3939

4040
The `DumpToArray` method makes a copy of all the data stored in the current instance. The data is returned in the *OutPutArray* parameter for avoid additional data copies in the internals.
4141

42-
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV data any more. In the same way, the `DumpToArray` method doesn’t perform any modifications to the *OutPutArray* array for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
42+
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV/TSV data any more. In the same way, the `DumpToArray` method doesn’t perform any modifications to the *OutPutArray* array for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
4343

4444
>⚠️**Caution**
4545
>{: .text-grey-lt-000 .bg-green-000 }
46-
>The data is always returned in a Two-dimensional array, even when the imported CSV file only contain a field per record.
46+
>The data is always returned in a Two-dimensional array, even when the imported file only contain a field per record.
4747
{: .text-grey-dk-300 .bg-yellow-000 }
4848

4949
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/dumptojaggedarray.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ See also
4242

4343
The `DumpToJaggedArray` method makes a copy of all the data stored in the current instance. The data is returned in the *OutPutArray* parameter for avoid additional data copies in the internals.
4444

45-
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV data any more. In the same way, the `DumpToJaggedArray` method doesn’t perform any modifications to the *OutPutArray* array for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
45+
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV/TSV data any more. In the same way, the `DumpToJaggedArray` method doesn’t perform any modifications to the *OutPutArray* array for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
4646

4747
>📝**Note**
4848
>{: .text-grey-lt-000 .bg-green-000 }

docs/api/methods/dumptosheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ See also
6060

6161
When the *WBookName* parameter is omitted the data is dumped into the Workbook that holds the CSV interface's *VBAProject*. Omitting the *SheetName* parameter adds a new Worksheet to the desired Workbook. Also, if the *RngName* parameter is omitted the data will dumped starting on the "A1" named cell in the desired Worksheet.
6262

63-
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV data any more. In the same way, the `DumpToSheet` method doesn’t perform any action for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
63+
The dumped data will be successively erased from memory, in other words, the current instance will doesn't hold the read CSV/TSV data any more. In the same way, the `DumpToSheet` method doesn’t perform any action for subsequent calls not preceded by one `ImportFromCSV` or `ImportFromCSVstring` method call.
6464
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/exporttocsv.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 5
88
# ExportToCSV
99
{: .fs-9 }
1010

11-
Exports an array's content to a CSV file.
11+
Exports an array's content to a CSV/TSV file.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -44,16 +44,16 @@ _None_
4444

4545
>📝**Note**
4646
>{: .text-grey-lt-000 .bg-green-000 }
47-
>Before invoke the `ExportToCSV` method, the user must to open a connection to the CSV file. Passing a variable that isn't an array will cause an error and the operation aborts.
47+
>Before invoke the `ExportToCSV` method, the user must to open a connection to the file. Passing a variable that isn't an array will cause an error and the operation aborts.
4848
{: .text-grey-dk-300 .bg-grey-lt-000 }
4949

5050
See also
51-
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeChar property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapechar.html).
51+
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeToken property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapetoken.html).
5252

5353
---
5454

5555
## Behavior
5656

57-
The `FieldsDelimiter`, `RecordsDelimiter` and `EscapeChar` properties sets the method's behavior to the needs.
57+
The `FieldsDelimiter`, `RecordsDelimiter` and `EscapeToken` properties sets the method's behavior to the needs.
5858

5959
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/getdatafromcsv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 6
88
# GetDataFromCSV
99
{: .fs-9 }
1010

11-
Dumps a CSV file content to a string variable
11+
Dumps a CSV/TSV file content to a string variable
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -27,7 +27,7 @@ The required *csvPathAndFilename* argument is an identifier specifying a `String
2727

2828
>📝**Note**
2929
>{: .text-grey-lt-000 .bg-green-000 }
30-
>The *csvPathAndFilename* parameter must be the full path to the target CSV file, this means, the parameter holds the folder path, the file name and the ".csv" extension.
30+
>The *csvPathAndFilename* parameter must be the full path to the target file, this means, the parameter holds the folder path, the file name and the extension.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

3333
## Behavior

docs/api/methods/importfromcsv.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 7
88
# ImportFromCSV
99
{: .fs-9 }
1010

11-
Imports a CSV file's content to the current instance.
11+
Imports a CSV/TSV file's content to the current instance.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -44,22 +44,22 @@ _None_
4444

4545
>📝**Note**
4646
>{: .text-grey-lt-000 .bg-green-000 }
47-
>If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
47+
>If the *HeadersOmission* parameter is set to `True`, the file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
4848
>The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
4949
{: .text-grey-dk-300 .bg-grey-lt-000 }
5050

5151
See also
52-
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeChar property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapechar.html), [StartingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/startingrecord.html), [EndingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/endingrecord.html), [CommentLineIndicator property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/commentlineindicator.html).
52+
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeToken property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapetoken.html), [StartingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/startingrecord.html), [EndingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/endingrecord.html), [CommentsToken property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/commentstoken.html).
5353

5454
---
5555

5656
## Behavior
5757

58-
User can set `CommentLineIndicator` property for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
58+
User can set `CommentsToken` property for those files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
5959

6060
>⚠️**Caution**
6161
>{: .text-grey-lt-000 .bg-green-000 }
62-
>Before invoke the `ImportFromCSV` method, the user must to open a connection to the CSV file. If the CSV file has no data, this is the file is an empty one, the `ImportFromCSV` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
62+
>Before invoke the `ImportFromCSV` method, the user must to open a connection to the file. If the target file has no data (the file is an empty one) the `ImportFromCSV` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
6363
{: .text-grey-dk-300 .bg-yellow-000 }
6464

6565
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/importfromcsvstring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 8
88
# ImportFromCSVstring
99
{: .fs-9 }
1010

11-
Parses a string and save its CSV data to the current instance.
11+
Parses a string and save its CSV/TSV data to the current instance.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -48,22 +48,22 @@ _None_
4848

4949
>📝**Note**
5050
>{: .text-grey-lt-000 .bg-green-000 }
51-
>If the *HeadersOmission* parameter is set to `True`, the CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
51+
>If the *HeadersOmission* parameter is set to `True`, the file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
5252
>The *PassControlToOS* parameter allows user to pass control to the operating system. Control is returned after the operating system has finished processing the events in its queue.
5353
{: .text-grey-dk-300 .bg-grey-lt-000 }
5454

5555
See also
56-
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeChar property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapechar.html), [StartingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/startingrecord.html), [EndingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/endingrecord.html), [CommentLineIndicator property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/commentlineindicator.html).
56+
: [OpenConnection method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openconnection.html), [FieldsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/fieldsdelimiter.html), [RecordsDelimiter property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/recordsdelimiter.html), [EscapeToken property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/escapetoken.html), [StartingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/startingrecord.html), [EndingRecord property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/endingrecord.html), [CommentsToken property](https://ws-garcia.github.io/VBA-CSV-interface/api/properties/commentstoken.html).
5757

5858
---
5959

6060
## Behavior
6161

62-
User can set `CommentLineIndicator` for those CSV files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the CSV file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
62+
User can set `CommentsToken` for those files having a combination of empties lines, blanks lines or commented ones for parse the file ONLY when the parser is working on `QuotationMode.Critical` mode. In that mode, the cited lines are simply skipped, leaving no empty values between records separated by this kind of lines. In other words, if the target file holds a record and then some special lines (blank, empty or commented) and then another record, the second record will be saved contiguous to the first record ignoring the lines between both.
6363

6464
>⚠️**Caution**
6565
>{: .text-grey-lt-000 .bg-green-000 }
66-
>If the CSV file has no data, this is the file is an empty one, the `ImportFromCSVstring` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
66+
>If the file has no data (the file is an empty one) the `ImportFromCSVstring` method returns an empty array, that is, an array bounded from 0 to -1 and holding no elements and no data.
6767
{: .text-grey-dk-300 .bg-yellow-000 }
6868

6969
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/openconnection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ nav_order: 11
88
# OpenConnection
99
{: .fs-9 }
1010

11-
Loads a CSV file on memory for data Input/Output operations.
11+
Loads a CSV/TSV file on memory for data Input/Output operations.
1212
{: .fs-6 .fw-300 }
1313

1414
---
@@ -44,13 +44,13 @@ _None_
4444

4545
>⚠️**Caution**
4646
>{: .text-grey-lt-000 .bg-green-000 }
47-
>The `OpenConnection` method don't rejects any kind of file extension, user need to ensure the target file has a name ending in `.csv` or `.txt`.
47+
>The `OpenConnection` method don't rejects any kind of file extension, user need to ensure the target file has a name ending in `.csv`, `.tsv` or `.txt`.
4848
{: .text-grey-dk-300 .bg-yellow-000 }
4949

5050
>📝**Note**
5151
>{: .text-grey-lt-000 .bg-green-000 }
5252
>The `OpenConnection` method is the preamble to the `ImportFromCSV` and `ExportToCSV` methods, this means each call to the citated methods must be preceded by a `OpenConnection` method call.
53-
>After call the `OpenConnection` method is possible to check if the instance is bind to the CSV file, for which is only needed to read the current instance `Connected` property.
53+
>After call the `OpenConnection` method is possible to check if the instance is bind to the target file, for which is only needed to read the current instance `Connected` property.
5454
{: .text-grey-dk-300 .bg-grey-lt-000 }
5555

5656
See also
@@ -60,6 +60,6 @@ See also
6060

6161
## Behavior
6262

63-
When the given path exists the file will be created on that path, otherwise an error occur. For on path existing CSV file, the `OpenConnection` method will delete the file when the *DeleExistingFile* parameter is set to `True`. If that is not the case, a new file will be created.
63+
When the given path exists the file will be created on that path, otherwise an error occur. For on path existing file, the `OpenConnection` method will delete the file when the *DeleExistingFile* parameter is set to `True`. If that is not the case, a new file will be created.
6464

6565
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/resettodefault.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ _None_
2727

2828
>📝**Note**
2929
>{: .text-grey-lt-000 .bg-green-000 }
30-
>Before call the `ResetToDefault` method, user must to check if the target CSV file will be well parsed with the config options shown in the table below.
30+
>Before call the `ResetToDefault` method, user must to check if the target file would be well parsed with the config options shown in the table below.
3131
{: .text-grey-dk-300 .bg-grey-lt-000 }
3232

3333
<table>
@@ -51,8 +51,8 @@ _None_
5151
<td style="text-align: left;"><p style="color:navy;">vbCrLf</p></td>
5252
</tr>
5353
<tr>
54-
<td style="text-align: left;"><em>EscapeChar</em></td>
55-
<td style="text-align: left;"><p style="color:navy;"><code>EscapeType</code>.DoubleQuotes</p></td>
54+
<td style="text-align: left;"><em>EscapeToken</em></td>
55+
<td style="text-align: left;"><p style="color:navy;"><code>EscapeTokens</code>.DoubleQuotes</p></td>
5656
</tr>
5757
<tr>
5858
<td style="text-align: left;"><em>QuotingMode</em></td>

0 commit comments

Comments
 (0)