The LINGO DLL exports twelve functions. The exported functions are contained in the file Lingo15/Lingd15.Dll. The library file Lingo15\Programming Samples\Lingd15.lib may be used to import these functions into your own custom application.

Below is a list of the functions exported by the LINGO DLL, along with a brief description of each routine’s functionality. The definitions are written using C language conventions. Refer to the programming samples in the following sections for specific examples of the use of each of these routines using Visual C and Visual Basic.

void LSclearPointersLng( pLSenvLINGO pL)

This clears out the list of @POINTER() pointers to user memory transfer areas established through calls to LSsetPointerLng().

Arguments:

int LScloseLogFileLng( pLSenvLINGO pL)

This closes LINGO’s log file that was opened previously by a call to LSopenLogFileLng().

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

pLSenvLINGO CALLTYPE LScreateEnvLng()

This creates a LINGO environment object. All other LINGO DLL routines require a valid pointer to a LINGO environment object. You should free this object at the end of your application by calling LSdeleteEnvLng(). LScreateEnvLng() will search the application's startup directory and the system path for a valid LINGO license file.  If you would prefer to pass LINGO the license key directly, refer to the following function, LScreateEnvLicenseLNG().

Return Value:

Returns 0 if an error occurred, otherwise, a pointer to a LINGO environment object is returned.

pLSenvLINGO CALLTYPE LScreateEnvLicenseLng( char* pcLicenseKey, int* pnErr)

This creates a LINGO environment object. All other LINGO DLL routines require a valid pointer to a LINGO environment object. You should free this object at the end of your application by calling LSdeleteEnvLng(). LScreateEnvLicenseLng() requires that you pass the license key directly.  If you would prefer to have LINGO search the application's startup directory and the system path for a valid LINGO license file, refer to the previous function, LScreateEnvLng().

Arguments:

Return Value:

Returns 0 if an error occurred, otherwise, a pointer to a LINGO environment object is returned.

int LSdeleteEnvLng( pLSenvLINGO pL)

This deletes a LINGO environment object previously created through a call to LScreateEnvLng(), which frees up the system memory allocated to the LINGO object.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

int LSexecuteScriptLng( pLSenvLINGO pL, char* pcScript)

This routine is the main workhorse of the LINGO DLL that processes LINGO command scripts. The script may be contained entirely in memory, or it may contain one or more TAKE commands to load scripts from disk.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

int LSgetCallbackInfoLng( pLSenvLINGO pL, intnObject, void* pResult)

You may establish a function in your application that the LINGO solver calls back to at regular intervals to keep you abreast of its progress. We refer to this type of routine as being a callback function, and you may refer to section Callback Functions for more information.  Your callback function may then call LINGO through LSgetCallbackInfoLng() to request specific information from the solver while it is processing a model.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

int LSgetCallbackVarPrimalLng( pLSenvLINGO pL, char* pcVarName, double* pdPrimals)

You may establish a function in your application that the LINGO solver calls back to at regular intervals to keep you abreast of its progress. We refer to this type of routine as being a callback function, and you may refer to section Callback Functions for more information. Your callback function may then call LINGO through LSgetCallbackVarPrimal() to request the current values for attributes and/or scalar variables.  This will allow you to keep your users posted on the values of the model's variables in the current best solution found so far.  This routine will only return values successfully when solving integer models, or when solving models with the global solver.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

int LSopenLogFileLng( pLSenvLINGO pL, char *pcLogFile)

This creates a file for LINGO to write a log to while processing your script. In general, you should always try to create a log file (at least in the early stages of your project) to assist with debugging. If an error is occurring and you are not exactly sure why, then it is always a good idea to refer to the log file for a clue.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

int LSsetCallbackErrorLng( pLSenvLINGO pL, lngCBFuncError_t pcbf, void* pUserData)

Use this routine to specify a callback function that LINGO will call whenever an error is encountered. This allows you application to keep close watch on any unusual conditions that might arise while processing your script.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

The callback function you supply must use the standard call convention and must have the following interface:

int MyErrCallback( pLSenvLINGO pL, void* pUserData, int nErrorCode, char* pcErrorText)

Your computer will most likely crash if you don’t follow this interface specification exactly. The LINGO error code is reported through the nErrorCode argument, along with the error text in pcErrorText. You should set aside at least 200 bytes for the error text. The list of LINGO error codes can be found in the Error Messages section.

int LSsetCallbackSolverLng( pLSenvLINGO pL, lngCBFuncError_t pcgf, void* pUserData)

Use this routine to specify a callback function that LINGO will call at frequent intervals when solving a model.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.

The callback function you supply must use the standard call convention and must have the following interface:

int MySolverCallback( pLSenvLINGO pL, int nReserved, void* pUserData)

Your computer will most likely crash if you don’t follow this interface specification exactly. The nReserved argument is reserved for future use and may be ignored.

int CALLTYPE LSsetPointerLng( pLSenvLINGO pL, double* pdPointer, int* pnPointersNow)

Call this routine one or more times to pass a list of memory pointers to LINGO. These pointers are used by LINGO’s @POINTER() function for moving data into and solutions out of the solver. In other words, this allows you to have direct memory links with LINGO for fast and convenient data transfer.

Arguments:

Return Value:

Returns 0 if no error occurred. Otherwise, one of the nonzero error codes listed in section LINGO DLL Error Codes is returned.