Initializing help system before first use

# General

### Initialization and termination

Each program using the Mosel libraries must start with a call to XPRMinit. If a Mosel library is loaded and unloaded dynamically at run time, the termination function XPRMfinish must be called before unloading the library in order to release the resources Mosel is using.

XPRMfinish, XPRMfree | Finish Mosel.
XPRMfreelibpath | Release the memory allocated by XPRMgetlibpath.
XPRMgetdefworkdir | Get default current working directory.
XPRMgetlibpath | Get the location of the Mosel runtime library.
XPRMgetlicerrmsg | Get license error message.
XPRMgetlocaledir | Get the location of the translated messages.
XPRMgetsdmax | Get the maximum depth of a stack dump.
XPRMgetversion | Get the version number of Mosel.
XPRMgetversions | Get version numbers.
XPRMinit | Initialize Mosel.
XPRMremovetmpdir | Remove the Mosel temporary directory.
XPRMsetdefworkdir | Set default current working directory.
XPRMsetlocaledir | Set the location of the translated messages.
XPRMsetrestrictions | Set execution restrictions.
XPRMsetsdmax | Set the maximum depth of a stack dump.

### Model management

The following functions are required to manipulate models loaded in core memory: loading, running or unloading a model, getting information. Several models may be loaded in a single session of Mosel and used alternatively: each function requires a model (type XPRMmodel) as parameter to designate on which of the loaded models the operation is to be performed. This object of type XPRMmodel is returned by the function XPRMloadmod when a model has been successfully read from a bim (= binary model) file—BIM files are produced by the Mosel compiler either by using the command line interpreter or with the Model Compiler Library.—.

XPRMaddparamstr | Add a parameter definition to a parameter string.
XPRMfindmod | Find a model by its name or order number.
XPRMgetannotations | Retrieve annotations of a model.
XPRMgetbimprefix | Get the list of prefixes for loading of packages.
XPRMgetmodprop | Get a property of a model.
XPRMgetnextdep | Enumerate dependencies of a model or package.
XPRMgetnextmod | Get the next model.
XPRMgetnextmoddso | Get the next module loaded for a model.
XPRMisrunmod | Check if a model is running.
XPRMloadmod, XPRMloadmodsec | Load a Binary Model file.
XPRMresetmod | Reset a model.
XPRMrunmod | Run a model.
XPRMsetbimprefix | Set the list of prefixes for loading of packages.
XPRMsetdefstream | Set default input/output streams.
XPRMstoprunmod | Stop a running model.
XPRMtermrunmod | Terminate execution of a model.
XPRMunloadmod | Unload a model.

Covered Topics

- XPRMaddparamstr
- XPRMfindmod
- XPRMfinish, XPRMfree
- XPRMfreelibpath
- XPRMgetannotations
- XPRMgetbimprefix
- XPRMgetdefworkdir
- XPRMgetlibpath
- XPRMgetlicerrmsg
- XPRMgetlocaledir
- XPRMgetmodprop
- XPRMgetnextdep
- XPRMgetnextmod
- XPRMgetnextmoddso
- XPRMgetsdmax
- XPRMgetversion
- XPRMgetversions
- XPRMinit
- XPRMisrunmod
- XPRMloadmod, XPRMloadmodsec
- XPRMremovetmpdir
- XPRMresetmod
- XPRMrunmod
- XPRMsetbimprefix
- XPRMsetdefstream
- XPRMsetdefworkdir
- XPRMsetlocaledir
- XPRMsetrestrictions
- XPRMsetsdmax
- XPRMstoprunmod
- XPRMtermrunmod
- XPRMunloadmod

Parent Topic Mosel Run Time Library

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.