.FILE RESTRUCT

This subroutine will restructure the specified file.

Usage:

      PASS         <error_msg>                FIELD            SHARE? Y
      PASS         <file_name>                FIELD            SHARE? N
      PASS         <application>              FIELD            SHARE? N
      PASS         <database>                 FIELD            SHARE? N
      GOSUB    --- .FILE RESTRUCT
      *        Check for errors
      IF       --- .FILE RESTRUCT             NE

Description:

This subroutine will restructure the specified file. This routine performs the same function as 'Restructure' in Data File Management.

It has the same restrictions as Data File Management, ie, the user running the command must be either a System Administrator, or have Database Management rights for the Database/Application. The file to be created must be a Disk Permanent file, the 'Create By Database Mgmt?' flag in the Data Dictionary must be "Y", and the 'Use DB' field must be blank.

<error_message> contains additional error information if the command fails (Required). Must be PASSed with Share "Y". Note that this message can be up to 500 characters in length.

<file_name> is the file to be restructured (Required). This must be a file defined in your Data Dictionary.

<application> is the application that contains the Data Dictionary for <file_name> (Optional). If not specified, it will default to the current application.

<database> is the database in which the file should be restructured (Optional). If not specified, it will default to the current Database.

If --- .FILE RESTRUCT contains 'Unable to Restructure', you can check the <error_message> field for more information on why the restructure failed.

If it contains 'Restructure Complete', <error_message> will contain additional information, such as 'Restructure Not Required', 'Structure File Rebuilt', or 'Restructured'. If <error_message> contains 'Restructured', that indicates that an actual restructure was performed.

Comments:

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

-- JeanNeron - 2012-03-01