Click or drag to resize

Header Function (Usual)

X#
Return the length of the database file header.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
Copy
 FUNCTION Header(
	uArea AS USUAL
) AS LONG
Request Example View Source

Parameters

uArea
Type: Usual
Specifies the work area name or number for a table from which the value must be retrieved.

Return Value

Type: Long
The number of bytes in the header of the database file.
If no database file is in use, Header() returns a 0.
Remarks
Header() is used with LastRec(), RecSize(), and DiskSpace() to create procedures for backing up files.
By default, this function operates on the currently selected work area.
It can be made to operate on an unselected work area by specifying it within an aliased expression or by calling the overload that accepts a workarea parameter (a workarea number or alias ).
Examples
This example determines the header size of the SALES.DBF:
X#
Copy
1USE sales NEW
2QOut(Header())            // Result: 258
This example defines a pseudofunction, DBFSize(), that uses Header() with RecSize() and LastRec() to calculate the size of the current database file in bytes:
X#
Copy
1define DBFSize() ((RecSize() * LastRec()) + Header() + 1)
Later you can use DBFSize() as you would any function:
X#
Copy
1USE sales NEW
2USE customer NEW
3QOut(DBFSize())
4QOut(Sales->DBFSize())
See Also