Initializing help system before first use

XPRDcompmod, XPRDcompmodsec

XPRDcompmod, XPRDcompmodsec

Purpose
Compile a model source file.
Synopsis
int XPRDcompmod(XPRDmosel mosel, const char *options, const char *srcfile, const char *dstfile, const char *userc);
int XPRDcompmodsec(XPRDmosel mosel, const char *options, const char *srcfile, const char *dstfile, const char *userc, const char *passfile, const char *privkey, const char *kfile);
Arguments
mosel 
Mosel instance
options 
Compilation options (may be NULL). Possible values:
"g" 
Include debugging information: in the case of a run time error during the execution of the model the location of the error in the source file may be indicated
"G" 
Include tracing information: with this option the model can be run through the debugger for an execution step by step
"s" 
Strip symbols: secure the bim file by removing all private symbol names used in the source model
"p" 
Parse only: stop after the syntax analysis of the source file, do not compile (no file generated)
"bx=prefix" 
Package prefix (can be quoted with single or double quotes)
"ix=prefix" 
Include source prefix (can be quoted with single or double quotes)
"S" 
Sign the bim file
"E" 
Encrypt the bim file
"F" 
The argument pass is a file name (not the password itself)
"V" 
Accept to load signed packages only if their signature can be verified
"T" 
Accept to load only signed packages with a valid signature
scrfile 
Name of the source file
dstfile 
Name of the destination file (may be NULL)
userc 
Commentary text that will be saved as is at the beginning of the output file (may be NULL)
passfile 
Password or password file (for encryption with a password)
privkey 
Private key file (for bim file signing)
kfile 
File of public keys (for encryption with public keys)
Return value
Execution status:
0 
Function executed sucessfully
1 
Parsing phase has failed (syntax error or file access error)
2 
Error in compilation phase (a semantic error has been detected)
3 
Error writing the output file
4 
License error (compiler not authorized)
Example
Ask the Mosel instance minst to compile the model "mymod.mos" stored locally. The resulting bim file "mymod.bim" is saved on the host running this instance: 
m=XPRDcompmod(minst, "", "rmt:mymod.mos", "mymod.bim", "");
Further information
1. This function compiles a given model source file into a binary model file (bim file) that is required as input to function XPRDloadmod for executing the model. The second form of the function will be used to generate encrypted and/or signed bim files.
2. The source file name may contain environment variable references using the notation ${varname} (for example, ` ${XPRESSDIR}/examples/mymodel') that are expanded to generate the actual name.
3. When sending a compilation request to a separate Mosel instance, it is important to keep in mind that the operation is performed in the environment of this 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).
4. The argument kfile is a list of public key files ( i.e. each line of the file is a key file name): when encrypting a file, the encryption is performed for each of the listed public keys such that the bim file can be decrypted by any of the corresponding private keys.
Related topics
XPRDloadmod, XPRDrunmod.

Parent Topic Mosel instances management