DelSubstKey

Syntax

DelSubstKey(tbl_file, str_key);

tbl_file	A string specifying the path and filename of the table.
str_key	The key of the entry to delete.

Description

Deletes an entry specified by str_key from the substitution table tbl_file. It does not affect the physical file stored on disk, only the representation of the table in the memory.

Returns

A number indicating whether the entry was deleted successfully.

	Entry deleted successfully.
	Entry not deleted successfully.

Example

In this example, the following substitution table (author.tbl) is used.

//!CodePage UTF8! //!multicolumn! agatha christie 1890 alfred hitchcock 1899

The following script deletes an entry from the physical substitution table stored on disk (author.tbl):

DelSubstKey("../data/tables/author.tbl","alfred");

WriteSubst("../data/tables/author.tbl");

After the script is executed, author.tbl is changed as follows:

//!CodePage UTF8! //!multicolumn! agatha christie 1890

Notes

•	A substitution table is kept in memory until the script function EraseSubst is called for that table.