Write Delimited Spreadsheet function: Difference between revisions
Appearance
Started page |
m →Usage |
||
| Line 6: | Line 6: | ||
== Usage == | == Usage == | ||
{ | This VI is polymorphic and has three instances: | ||
=== Double Instance === | |||
[[File:Write Delimited Spreadsheet - Double Instance.png|center]] | |||
{| class="wikitable" | |||
! Data Type | |||
! Name | |||
! Description | |||
|- | |||
! [[File:String.png|link=String data type]] | |||
| '''format''' | |||
| '''format''' specifies how to convert the numbers to characters. If the '''format''' is %.3f (default), the VI creates a string long enough to contain the number, with three digits to the right of the decimal point. If '''format''' is %d, the VI converts the data to integer form using as many characters as necessary to contain the entire number. If '''format''' is %s, the VI copies the input string. Use the [[Format string syntax|format string syntax]]. | |||
|- | |||
! [[File:Path.png|link=Path data type]] | |||
| '''file path''' | |||
| '''file path''' is the path name of the file. If '''file path''' is empty (default) or is <Not A Path>, the VI displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog box. | |||
|- | |||
! [[File:Double Float 2D Array.png|link=Double Float Array data type]] | |||
| '''2D data''' | |||
| '''2D data''' specifies the data to write to the file if '''1D data''' is not wired or is empty. | |||
|- | |||
! [[File:Double Float Array.png|link=Double Float Array data type]] | |||
| '''1D data''' | |||
| '''1D data''' specifies the data to write to the file if this input is not empty. The VI converts the 1D array into a 2D array before proceeding. | |||
|- | |||
! [[File:Boolean.png|link=Boolean data type]] | |||
| '''append to file?''' | |||
| '''append to file?''' appends data to an existing file, if TRUE ([[File:BooleanTrue2010.png]]). If '''append to file?''' is FALSE (default) ([[File:BooleanFalse2010.png]]), the VI replaces data in an existing file. If there is no existing file, the VI creates a new file. | |||
|- | |||
! [[File:Error Cluster.png|link=Error Cluster data type]] | |||
| '''error in''' | |||
| '''error in''' describes error conditions that occur before this node runs. This input provides [[Error Cluster data type|standard error]] in functionality. | |||
|- | |||
! [[File:Boolean.png|link=Boolean data type]] | |||
| '''transpose?''' | |||
| '''transpose?''' specifies whether the VI transposes the data after converting it from a string. The default is FALSE ([[File:BooleanFalse2010.png]]). | |||
|- | |||
! [[File:String.png|link=String data type]] | |||
| '''delimiter''' | |||
| '''delimiter''' is the character or string of characters to use to separate fields in the spreadsheet file. For example, a value of <code>,</code> (comma) specifies a single comma as the delimiter. The default is <code>\t</code>, which specifies a single tab character as the delimiter. | |||
|- | |||
! [[File:Path Indicator.png|link=Path data type]] | |||
| '''new file path''' | |||
| '''new file path''' returns the path to the file. | |||
|- | |||
! [[File:Error Cluster Indicator.png|link=Error Cluster data type]] | |||
| '''error out''' | |||
| '''error out''' contains error information. This output provides [[Error Cluster data type|standard error]] out functionality. | |||
|} | |||
=== Integer Instance === | |||
=== String Instance === | |||
== History == | == History == | ||
Revision as of 19:20, 2 December 2020
| |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
| Object information | |
|---|---|
| Owning palette(s) | File I/O palette |
| Type | VI |
| Requires | Basic Development Environment |
| Icon | |
The Write Delimited Spreadsheet function converts a 2D or 1D array of strings, signed integers, or double-precision numbers to a text string and writes the string to a new byte stream file or appends the string to an existing file. Wire data to the 2D data input or 1D data input to determine the polymorphic instance to use or manually select the instance.
Usage
This VI is polymorphic and has three instances:
Double Instance

| Data Type | Name | Description |
|---|---|---|
| format | format specifies how to convert the numbers to characters. If the format is %.3f (default), the VI creates a string long enough to contain the number, with three digits to the right of the decimal point. If format is %d, the VI converts the data to integer form using as many characters as necessary to contain the entire number. If format is %s, the VI copies the input string. Use the format string syntax. | |
| file path | file path is the path name of the file. If file path is empty (default) or is <Not A Path>, the VI displays a dialog box from which you can select a file. Error 43 occurs if you cancel the dialog box. | |
| 2D data | 2D data specifies the data to write to the file if 1D data is not wired or is empty. | |
| 1D data | 1D data specifies the data to write to the file if this input is not empty. The VI converts the 1D array into a 2D array before proceeding. | |
| append to file? | append to file? appends data to an existing file, if TRUE ( | |
| error in | error in describes error conditions that occur before this node runs. This input provides standard error in functionality. | |
| transpose? | transpose? specifies whether the VI transposes the data after converting it from a string. The default is FALSE ( | |
| delimiter | delimiter is the character or string of characters to use to separate fields in the spreadsheet file. For example, a value of , (comma) specifies a single comma as the delimiter. The default is \t, which specifies a single tab character as the delimiter.
| |
| new file path | new file path returns the path to the file. | |
| error out | error out contains error information. This output provides standard error out functionality. |
Integer Instance
String Instance
History
| |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
| More info to come. |
See Also
| |
Add links to internal resources that would also help. |
External Links
| |
Add links to external resources that would also help. |