Difference between revisions of "HEADER()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
 
Line 1: Line 1:
 
 
 
==Purpose==
 
==Purpose==
 
Function to return the table header size
 
Function to return the table header size
Line 25: Line 23:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 16:23, 2 December 2009

Purpose

Function to return the table header size


Syntax

HEADER()


See Also

DISKSPACE(), RECCOUNT(), RECSIZE()


Description

The HEADER() function returns the size of a table header. The table file header contains information about the table, among other things, the field definitions, and the field descriptions. When used with the RECSIZE() function and the RECCOUNT() function, the HEADER() function allows you to calculate the space which your table occupies. The total space needed to backup your table can thus be calculated.


Example

use mytable
size = header() + reccount() * recsize()


Products

Recital Server, Recital