Initializing help system before first use

XPRDloadmod, XPRDloadmodsec

XPRDloadmod, XPRDloadmodsec


Purpose
Load a Binary Model file onto the specified instance.
Synopsis
XPRDmodel XPRDloadmod(XPRDmosel mosel, const char *bname);
XPRDmodel XPRDloadmodsec(XPRDmosel mosel, const char *bname, const char *flags, const char *passfile, const char *privkey, const char *keys);
Arguments
mosel 
Mosel instance
bname 
Name of a binary model file
flags 
Loading options:
"c" 
Check signature (if the file is signed)
"V" 
If the file is signed, load it only if the signature is valid
"T" 
Load only signed files with a valid signature
"F" 
The argument passfile is a file name (not the password itself)
passfile 
Password or password file (for encrypted bim files)
privkey 
Private key file (for encrypted bim files)
keys 
File of public keys
Return value
Reference to the model that has been loaded or NULL.
Example
Load model "myfile.bim" stored locally onto the minst remote instance:
m=XPRDloadmod(minst, "rmt:mymod.bim"); 
Further information
1. This function returns the reference of a new model instance created from a binary model file. The second form of the function will be used to load encrypted and/or signed bim files if additional information has to be provided. While loading a model from a file, Mosel also automatically opens any additional modules that are required by this model.
2. It is important to keep in mind that the operation is performed in the environment of a remote instance (in particular its current working directory) and file names should be specified appropriately (the rmt: I/O driver can be particularly helpful in this context).
3. Default streams of the newly created model are inherited from the Mosel instance mosel. These settings can be changed using XPRDsetdefstream.
4. The argument keys is a list of public key files ( i.e. each line of the file is a key file name): when a signed bim file is loaded, its signature is checked with the keys listed in this file. If this argument is not specified, the signing key is searched in the default public keys directory located at getparam("ssl_dir")+"/pubkeys".
Related topics