Difference between revisions of "SET LIBRARY"

Latest revision as of 15:03, 18 February 2010

Purpose

Load a library file built with the Recital C Extensions API

Syntax

SET LIBRARY TO [<library filename> | (<expC>) [ADDITIVE]]

See Also

CLOSE PROCEDURE, DISPLAY PROCEDURE, DO, FUNCTION, LINK, LIST PROCEDURE, LOADLIBRARY(), PARAMETERS, PROCEDURE, RELEASE LIBRARY, REQUIRE(), REQUIRE_ONCE()

Description

The SET LIBRARY TO <library filename> command opens the specified API procedure library file, scans the contents of it, and records the names and positions of the procedures defined within it. The filename can be substituted with a <expC>, enclosed in round brackets, which returns a valid filename. You can place as many procedures as you want in an API procedure library file. By default, library files are loaded from the directory defined in the DB_LIBDIR Registry setting / environment variable. To load a library that is not in the current directory or the DB_LIBDIR directory, the full path must be included.

If the optional ADDITIVE keyword is specified then any API procedures that are already open are left open and the new API procedure library is added. The SET LIBRARY TO command, without any filename specified, closes all active API procedure library files. A closed library file discards any knowledge of where the procedures within reside. The RELEASE LIBRARY <library filename> command can be used to close an individual API library file.

The SET LIBRARY and RELEASE LIBRARY commands only affect API procedure library files, not Recital procedure library files: these are handled by the SET PROCEDURE and CLOSE PROCEDURE commands and the REQUIRE() and REQUIRE_ONCE() functions.

The active API procedures and functions can be listed with the LIST or DISPLAY PROCEDURE commands.

For full details on using the Recital C Extensions API, please see C Extensions API.

Example

// Open Samples.so API procedure library
set library to samples.so
// Open pdf.so procedure library without closing active libraries
set library to pdf.so additive
// Close pdf.so API procedure library
release library pdf.so
// Close all active API procedure library files
set library to

Products

Recital Server, Recital