0LASubrEnvGetPathName < Main

Tags: view all tags
---+ .ENV GET PATH NAME

_This subroutine returns the path name of the requested Appx file._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;file_path&gt;                FIELD            SHARE? Y
      PASS         &lt;app_id&gt;                   FIELD            SHARE? N
      PASS         &lt;file_name&gt;                FIELD            SHARE? N
      PASS         &lt;error_msg&gt;                FIELD            SHARE? Y
      PASS         &lt;database&gt;                 FIELD            SHARE? N
      PASS         &lt;version&gt;                  FIELD            SHARE? N
      GOSUB    --- .ENV GET PATH NAME
      *        Check for errors
      IF       --- .ENV GET PATH NAME         NE
</pre>
---++ Description:

This subroutine returns the path name of the requested Appx file. The first three parameters are required, if any are missing the subroutine will CANCEL. The remaining parameters are optional, depending on the type of file (see below).

&lt;file_path&gt; returns the path and file name of the requested file (Required). This must be PASSed with Share "Y" to return the value. Note that this will not include the '.dat' extension

&lt;app_id&gt; is the application id of the file you are interested in (Required).

&lt;file_name&gt; is the Data Dictionary name of the file you are interested in (Required).

&lt;error_msg&gt; will contain any additional error information (optional).

&lt;database&gt; is the name of the database that contains the file you are interested in. If not PASSed, it will default to the current database.

&lt;version&gt; is the version that contains the file you are interested in. If not PASSed, it will default to the version used by &lt;database&gt;, unless you are checking a Design File (see below).

This will only work for permanent disk based files. You cannot use this on Appx/Net files, or files stored in a RDBMS.

There are 3 types of files you can inquire on. Each type has it's own requirements for the parameters that must be passed:

Normal Data Files
   * &lt;app_id&gt; must be supplied
   * &lt;database&gt; is optional and will default to the current database
   * &lt;version&gt; is optional and will default to the start up version of the specified database
System Administration Files
   * &lt;app_id&gt; can be blank, the contents will be ignored.
   * &lt;database&gt; must be 0SA
   * &lt;version&gt; can be blank, the contents will be ignored.
Application Design Files
   * &lt;app_id&gt; must be filled in.
   * &lt;database&gt; must be 0AD
   * &lt;version&gt; must be filled in.
If the field you passed in &lt;file_path&gt; is too short to contain the data, --- .ENV GET PATH NAME will be set to "Data was truncated".

---++ Comments:

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

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-27
Topic revision: r4 - 2012-03-20 - JeanNeron