Difference between revisions of "INCLUDE()"
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | + | ==Purpose== | |
| + | Load a library file built with the Recital C Extensions API or a Recital procedure library | ||
| + | |||
| + | |||
| + | ==Syntax== | ||
| + | INCLUDE(<expC>) | ||
| + | |||
| + | |||
| + | ==See Also== | ||
| + | [[CLOSE PROCEDURE]], [[DO]], [[FUNCTION]], [[INCLUDE_ONCE()]], [[LINK]], [[LIST PROCEDURE]], [[PARAMETERS]], [[PROCEDURE]], [[RELEASE LIBRARY]], [[REQUIRE()]], [[REQUIRE_ONCE()]], [[SET LIBRARY]] | ||
| + | |||
| + | |||
| + | ==Description== | ||
| + | The INCLUDE() 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, '.so' is assumed on UNIX/Linux. To load a Recital procedure or class library file, the '.prg' or '.dbo' file extension must be included. You can place as many procedures or classes 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 [[Configuration Files|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 [[:Category:SDK|C Extensions API documentation]]. | ||
| + | |||
| + | |||
| + | ==Example== | ||
| + | <code lang="recital"> | ||
| + | // Open Samples.so API procedure library | ||
| + | include("Samples") | ||
| + | // Close pdf.so API procedure library | ||
| + | release library pdf.so | ||
| + | // Close all active API procedure library files | ||
| + | set library to | ||
| + | </code> | ||
| + | |||
| + | |||
| + | ==Products== | ||
| + | Recital, Recital Server | ||
| + | [[Category:Documentation]] | ||
| + | [[Category:Functions]] | ||
Latest revision as of 15:32, 2 March 2010
Purpose
Load a library file built with the Recital C Extensions API or a Recital procedure library
Syntax
INCLUDE(<expC>)
See Also
CLOSE PROCEDURE, DO, FUNCTION, INCLUDE_ONCE(), LINK, LIST PROCEDURE, PARAMETERS, PROCEDURE, RELEASE LIBRARY, REQUIRE(), REQUIRE_ONCE(), SET LIBRARY
Description
The INCLUDE() 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, '.so' is assumed on UNIX/Linux. To load a Recital procedure or class library file, the '.prg' or '.dbo' file extension must be included. You can place as many procedures or classes 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 include("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
