HEADER( ) Function

  • Article

Returns the number of bytes in the header of the current or specified table file.

HEADER([nWorkArea | cTableAlias])

Return Values

Numeric

Parameters

  • nWorkArea | cTableAlias
    Returns the header size for a table open in another work area. nWorkArea specifies the work area number and cTableAlias specifies the table alias. If you omit the work area and alias, HEADER( ) returns the size of the header for the table open in the current work area.

    HEADER( ) returns 0 if a table isn't open in the work area you specify. If a table doesn't have the alias you specify, Microsoft Visual FoxPro displays an error message.

Remarks

A table header contains information about the table itself, such as the field names and sizes and the presence of a memo file or structural index.

See Also

FSIZE( ) | RECSIZE( ) | HeaderHeight Property | Working with Table Aliases