REQUIRE()

Template:YLM to do Check php compatibility / OOPS

Purpose

Load a library file built with the Recital C Extensions API or a Recital procedure library

Syntax

REQUIRE(<expC>)

See Also

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

Description

The REQUIRE() function opens the specified API or Recital procedure library file, scans the contents of it, and records the names and positions of the procedures defined within it. The <expC> is the name of the library file. If the file extension is not stated, '.dll' is assumed on Windows and '.so' on UNIX/Linux. To load a Recital procedure library file, the '.prg' or '.dbo' file extension must be included. You can place as many procedures as you want in a procedure library file.

C Extensions libraries in the shared library directory are loaded automatically at the start of a Recital process. The shared library directory location is defined by the DB_LIBDIR environment variable in the recital.conf file.

The SET LIBRARY TO command, without any filename specified, closes all active C Extensions 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 C Extensions library file.

The SET PROCEDURE and CLOSE PROCEDURE commands can also be used to handle Recital procedure library files.

The active 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 the C Extensions API documentation.

Example

// Open Samples.so API procedure library
require("Samples")
// Close pdf.so API procedure library
release library pdf.so
// Close all active API procedure library files
set library to

Products

Recital, Recital Server