0LASubrFileCsvExport < Main

---+ .FILE CSV EXPORT

_This subroutine is called to export an APPX file in CSV format. Release 5.4.0 & up._

<br />%TOC%
---++ Usage:
<pre>*     PASS         &lt;error_msg&gt;                FIELD            SHARE? Y
*     PASS         &lt;file_name&gt;                FIELD            SHARE? N
*     PASS         &lt;application&gt;              FIELD            SHARE? N
*     PASS         &lt;database&gt;                 FIELD            SHARE? N
*     PASS         &lt;count success&gt;            FIELD            SHARE? Y
*     PASS         &lt;count total&gt;              FIELD            SHARE? Y
*     PASS         &lt;count fail&gt;               FIELD            SHARE? Y
*     PASS         &lt;path & file name&gt;         FIELD            SHARE? N
*     PASS         &lt;include headings&gt;         FIELD            SHARE? N
*     GOSUB    --- .FILE CSV EXPORT
      *        Check for errors
*     IF       --- .FILE CSV EXPORT           NE

</pre>
---++ Description:

This subroutine will export the specified file in CSV format.

&lt;error_message&gt; contains additional error information if the command fails (Required). Must be PASSed with Share "Y".

&lt;file_name&gt; is the name of the APPX file to export (Required).

&lt;application&gt; is the name of the application containing the file to export. This is optional and if not specified it will default to the current application.

&lt;database&gt; is the name of the database containing the file to export. This is optional and if not specified it will default to the current database.

&lt;count_success&gt; is the count of records successfully exported. This is optional and must be PASSed with Share "Y" to return a value.

&lt;count_total&gt; is the total count of records processed, whether they were successfully exported or not. This is optional and must be PASSed with Share "Y" to return a value.

&lt;count_error&gt; is the count of records that were not exported. This is optional and must be PASSed with Share "Y" to return a value.

&lt;path & file name&gt; is an optional location for the exported data *(5.4.5 and higher only)*.

&lt;include headings&gt; is a Y/N flag to determine whether the first line should contain column headings or not <b>(5.4.7 / 6.0.1 and higher only). </b>Optional, defaults to "N".

The exported file is always exported to the $APPXPATH/&lt;database&gt;/&lt;application&gt;/Portdata/ folder and named &lt;file_name&gt;.csv. If you specified a &lt;path & file name&gt;, it will be copied to that location for you.

NOTE: The user must have Data Management rights for the Database / Application you want to export, or be an APPX System Administrator.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.PeteBrower - 2011-08-12
This topic: Main > WebHome > FullAPIList > 0LASubrFileCsvExport
Topic revision: r5 - 2019-09-26 - JeanNeron