SizeWarning (NotesDatabase - JavaScript)

Read-write. The size warning threshold of a database, in kilobytes.

Defined in

NotesDatabase

Syntax

getSizeWarning() : long

setSizeWarning(warning:long) : void

Usage

The size warning threshold for a database specifies the amount of disk space that the server administrator is willing to provide for that database before displaying a warning. This property can only be set by a script that has administrator access to the server on which the database resides.

If there is no size warning threshold for the database, this property returns 0.

In the Administration Client, use the "Set Quotas" tool to set the size warning.

The database does not need to be open to use this property.

Examples

This computed field displays the size quota and warning for the current database.
return "Size quota = " + database.getSizeQuota() + " kilobytes, warning = " + database.getSizeWarning();
This button removes the size quota and warning for the current database.
database.setSizeQuota(0);
database.setSizeWarning(0);