6.1 Notes

The SP_PATH variable

It is normally not necessary to set this system property (or environment variable), but its value will be used, as a fall-back, at runtime if no explicit boot path is given when initializing a runtime or development system. In this chapter, SP_PATH is used as a shorthand for the SICStus Prolog installation directory, whose default location for SICStus 4.1.3 is /usr/local/lib/sicstus-4.1.3) for UNIX and C:\Program Files\SICStus Prolog 4.1.3 for Windows. See System Properties and Environment Variables for more information.

Windows note: Explicit use of the SP_PATH variable is discouraged, since Windows applications can find out for themselves where they were started from. SP_PATH is only used if the directory where sprt4-1-3.dll is loaded from does not contain sp-4.1.3 (a directory), sprt.sav, or spre.sav. If SP_PATH is used, SICStus expects it to be set such that %SP_PATH%\bin contains sprt.sav or spre.sav. See Runtime Systems on Target Machines.

Definitions and declarations

Type definitions and function declarations for the interface are found in the header file <sicstus/sicstus.h>.

Error Codes

The value of many support functions is a return code, namely: SP_SUCCESS for success, SP_FAILURE for failure, SP_ERROR if an error condition occurred, or if an uncaught exception was raised during a call from C to Prolog. If the value is SP_ERROR, the macro SP_errno will return a value describing the error condition:

          int SP_errno
     

The function SP_error_message() returns a pointer to the diagnostic message corresponding to a specified error number.

Wide Characters

The foreign interface supports wide characters. Whenever a sequence of possibly wide character codes is to be passed to or from a C function it is encoded as a sequence of bytes, using the UTF-8 encoding. Unless noted otherwise the encoded form is terminated by a NUL byte. This sequence of bytes will be called an encoded string, representing the given sequence of character codes. Note that it is a property of the UTF-8 encoding that it does not change ASCII character code sequences.

If a foreign function is specified to return an encoded string, an exception will be raised if, on return to Prolog, the actual string is malformed (is not a valid sequence of UTF-8 encoded characters). The exception raised is representation_error(...,...,mis_encoded_string).