Difference between revisions of "LOADLIBRARY()"

Latest revision as of 16:51, 2 December 2009

Purpose

Load an API library file built with the Recital SDK

Syntax

LOADLIBRARY(<expC>)

See Also

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

Description

The LOADLIBRARY() function opens the specified API procedure library file, <expC>, scans the contents of it, and records the names and positions of the procedures defined within it. 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.

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 LOADLIBRARY() function and the SET LIBRARY and RELEASE LIBRARY commands only affect API procedure library files, not Recital/4GL 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. Classes can be listed with the LIST or DISPLAY CLASSES commands.

For full details on using the Recital SDK, please see the SDK documentation.

Example

// Open Samples.so API procedure library
loadlibrary("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