Zentitle SDK and Library
Public Member Functions | List of all members

Public Member Functions

int callPSLLibOpen (int LogLevel, String LicenseCode, String WorkDir, int LogQLen, int security) throws nalpError
 Initializes the Nalpeiron C library for use. See NalpLibOpen(). More...
 
int callPSLLibClose () throws nalpError
 Shuts down the library. THIS FUNCTION MUST BE CALLED IMMEDIATELY BEFORE CLOSING THE LIBRARY (ie with dlclose). If this function is not called before the library is closed, information may be lost and memory corruption could occur. More...
 
String callPSLGetErrorMsg (int nalpErrorNo) throws nalpError
 Get a descriptive string for nalpeiron error codes. More...
 

Member Function Documentation

String com.nalpeiron.passlibrary.NALP.callPSLGetErrorMsg ( int  nalpErrorNo) throws nalpError
inline

Get a descriptive string for nalpeiron error codes.

Parameters
nalpErrorNois a negative return value from one of the Nalpeiron functions
Returns
a descriptive string explaining that error.
int com.nalpeiron.passlibrary.NALP.callPSLLibClose ( ) throws nalpError
inline

Shuts down the library. THIS FUNCTION MUST BE CALLED IMMEDIATELY BEFORE CLOSING THE LIBRARY (ie with dlclose). If this function is not called before the library is closed, information may be lost and memory corruption could occur.

Exceptions
nalpErrorIf there was a problem calling the NSA function, this error will be thrown
Returns
= 0 If the call succeeded
Exceptions
nalpErrorIf there was a problem calling the NSL function, this error will be thrown. (Nalpeiron V10 error returns)
int com.nalpeiron.passlibrary.NALP.callPSLLibOpen ( int  LogLevel,
String  LicenseCode,
String  WorkDir,
int  LogQLen,
int  security 
) throws nalpError
inline

Initializes the Nalpeiron C library for use. See NalpLibOpen().

Parameters
LogLevelis an integer 0 to 6. If loglevel is not specified it will default to level 0 (off). You should not use log level higher than 4. The higher levels do not provide any useful end user debugging.
LicenseCodethe license code for this product
WorkDiris the location where the library will store all its working files (ie log file, cache file, license files, etc). If this value is not specified the files will be stored in the default Nalpeiron directory (cwd, or current working directory) on Linux and Mac, in a publically accessible directory selected by the OS on Windows).
LogQLenthe maximum length of the logging queue.
securityis used along with the authentication values stamped into the library to create a unique offset that is added to all returns. The default is 0 (ie returns from the library will NOT be modified).
Exceptions
nalpErrorIf there was a problem initializing the library this error will be thrown
Returns
= 0 If the call succeeded
< 0 A negative error value is returned (Nalpeiron V10 error returns)