Skip to content

Commit dc9408a

Browse files
committed
Update docs
1 parent da4c55a commit dc9408a

File tree

4 files changed

+34
-9
lines changed

4 files changed

+34
-9
lines changed

docs/api/methods/dumptosheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Dumps the data from the current instance to an Excel WorkSheet.
1515

1616
## Syntax
1717

18-
*expression*.`DumpToSheet`*({WBookName}, {SheetName}, {RngName})*
18+
*expression*.`DumpToSheet`*({WBookName}, {SheetName}, {RngName:= "A1"})*
1919

2020
### Parameters
2121

docs/api/methods/importfromcsv.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,38 @@ Imports a CSV file's content to an array.
1515

1616
## Syntax
1717

18-
*expression*.`ImportFromCSV`*({HeadersOmission})*
18+
*expression*.`ImportFromCSV`*({HeadersOmission:= `False`}, {PassControlToOS:= `True`})*
1919

2020
### Parameters
2121

22-
The optional *HeadersOmission* argument is an identifier specifying a `Boolean` variable.
22+
<table>
23+
<thead>
24+
<tr>
25+
<th style="text-align: left;">Part</th>
26+
<th style="text-align: left;">Description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td style="text-align: left;"><em>HeadersOmission</em></td>
32+
<td style="text-align: left;">Optional. Identifier specifying a <code>Boolean</code> variable.</td>
33+
</tr>
34+
<tr>
35+
<td style="text-align: left;"><em>PassControlToOS</em></td>
36+
<td style="text-align: left;">Optional. Identifier specifying a <code>Boolean</code> variable.</td>
37+
</tr>
38+
</tbody>
39+
</table>
2340

2441
### Return value
2542

2643
_None_
2744

2845
>:pencil: **NOTE:**
2946
>
30-
> Before invoke the `ImportFromCSV` method, the user must to open a connection to the CSV file. 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 CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
48+
>
49+
>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.
3150
3251
See also
3352
: [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).
@@ -40,6 +59,6 @@ User can set `CommentLineIndicator` for those CSV files having a combination of
4059

4160
>:warning: **CAUTION**
4261
>
43-
>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 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.
4463
4564
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/importfromcsvstring.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Parses a string and save its CSV data to an array.
1515

1616
## Syntax
1717

18-
*expression*.`ImportFromCSVstring`*(CSVstring, {HeadersOmission})*
18+
*expression*.`ImportFromCSVstring`*(CSVstring, {HeadersOmission:= `False`}, {PassControlToOS:= `False`})*
1919

2020
### Parameters
2121

@@ -35,6 +35,10 @@ Parses a string and save its CSV data to an array.
3535
<td style="text-align: left;"><em>HeadersOmission</em></td>
3636
<td style="text-align: left;">Optional. Identifier specifying a <code>Boolean</code> variable.</td>
3737
</tr>
38+
<tr>
39+
<td style="text-align: left;"><em>PassControlToOS</em></td>
40+
<td style="text-align: left;">Optional. Identifier specifying a <code>Boolean</code> variable.</td>
41+
</tr>
3842
</tbody>
3943
</table>
4044

@@ -44,7 +48,9 @@ _None_
4448

4549
>:pencil: **NOTE:**
4650
>
47-
>Before invoke the `ImportFromCSV` method, the user must to open a connection to the CSV file. 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 CSV file headers, first record, will be ignored by the parser only when the `StartingRecord` property is set to 1.
52+
>
53+
>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.
4854
4955
See also
5056
: [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).
@@ -57,6 +63,6 @@ User can set `CommentLineIndicator` for those CSV files having a combination of
5763

5864
>:warning: **CAUTION**
5965
>
60-
>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.
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.
6167
6268
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/openconnection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Loads a CSV file on memory for data Input/Output operations.
1515

1616
## Syntax
1717

18-
*expression*.`OpenConnection`*(csvPathAndFilename, {DeleExistingFile})*
18+
*expression*.`OpenConnection`*(csvPathAndFilename, {DeleExistingFile:= `False`})*
1919

2020
### Parameters
2121

0 commit comments

Comments
 (0)