Share via


DISPLAY STRUCTURE Command

Displays the structure of a table file. The name of each field in the table is displayed with its type and width.

DISPLAY STRUCTURE [IN nWorkArea | cTableAlias]
   [TO PRINTER [PROMPT] | TO FILE FileName [ADDITIVE]] [NOCONSOLE]

Parameters

  • IN nWorkArea | cTableAlias
    Displays the structure of the table in a work area other than the current work areas. nWorkArea specifies the work area number and cTableAlias specifies the table alias.

  • TO PRINTER [PROMPT]
    Directs output from DISPLAY STRUCTURE to a printer.

    You can include the optional PROMPT clause to display a dialog box before printing starts. In this dialog box, you can adjust printer settings, including the number of copies and page numbers to print. The printer settings that you can adjust depend on the currently installed printer driver. Place the PROMPT keyword immediately after TO PRINTER.

  • TO FILE FileName
    Directs output from DISPLAY STRUCTURE to the file specified with FileName. If the file already exists and SET SAFETY is ON, you are asked if you want to overwrite the file.

  • ADDITIVE
    Appends to the end of the named file. If you omit ADDITIVE, then the file is overwritten with the value of the expression.

  • NOCONSOLE
    Suppresses output to the main Visual FoxPro window or to the active user-defined window.

Remarks

DISPLAY STRUCTURE also displays the following:

  • The total width of all fields.

  • The number of decimal places in the field if the field has Numeric, Double, or Float type.

  • Null value support for each field.

  • If the field is an autoincrementing field, the Next and Step values in the last two columns.

  • The current number of records in the table and the date it was last updated.

  • The memo field block size if the table has an associated memo field.

  • The code page of the table.

  • If the table is associated with a structural compound index, and if a tag, or index entry, in the structural compound index has the same name as a field in the table, DISPLAY STRUCTURE displays the order of the tag, ascending or descending, and the collation sequence for the tag next to the field name. For more information about structural compound indexes and tags, see INDEX Command.

If the SET FIELDS is used to limit access to fields in the table, an angle bracket (>) appears beside the names of fields that can be accessed.

Example

In the following example, the customer table in the testdata database is opened. DISPLAY STRUCTURE is used to display the table structure.

CLOSE DATABASES
OPEN DATABASE (HOME(2) + 'Data\testdata')
USE customer  && Opens Customer table

CLEAR
DISPLAY STRUCTURE

See Also

Reference

DISPLAY Command

LIST Commands

DISPLAY TABLES Command

DISPLAY STATUS Command

Other Resources

Commands (Visual FoxPro)

Language Reference (Visual FoxPro)