GAMS Auditing and Licensing Object (PAL) Documentation

Generated for GAMS ..

Functions, Procedures, and Properties

 

License
Integer palLicenseLevel
 Access the license level
 
Integer palLicenseLevelSet
 Access the license level
 
Boolean palNetworkLicenseOK
 Indicator if validation of network license template is okay
 
Boolean palNetworkLicenseOKSet
 Indicator if validation of network license template is okay
 

Audit
void palSetAuditLine
 Sets audit string
 
void palSetSystemName
 Sets system name and sets up a generic audit string
 
Boolean palAuditRun
 Indicator for an audit run
 
ShortString palGetAuditLine
 Gets audit string
 
ShortString palGetCpr
 Gets copyright string
 
Integer palGetVer
 Major and Minor number combined as an int like 239
 
ShortString palGetRel
 Gets Major.Minor like 23.9
 
ShortString palGetGold
 Gets Maintenance number like 2 for 23.9.2
 
ShortString palGetCod
 Gets Platform code like WIN
 
ShortString palGetHdr
 Gets Platform text like x86/MS Windows
 
Integer palGetJul
 Get license check date as serial day number
 
ShortString palGetLicDat
 Gets build date like "Sep 19, 2012"
 
ShortString palGetBldCod
 Gets build code like LEG
 
ShortString palGetRelDat
 Gets license check date like "Dec 3, 2021 (ALPHA)" or "Dec 3, 2021 "
 
ShortString palGetRevision
 Gets global SVN revision number like r123456
 
Boolean palIsBeta
 Indicator for an beta system
 
Boolean palIsAlfa
 Indicator for an alpha system (deprecated)
 
Boolean palIsAlpha
 Indicator for an alpha system
 
Integer palGetToday
 Get todays date as serial day number
 
Integer palGetJulianDays
 Get serial day number from the string yymmdd
 
void palAuditFields
 Chops audit line apart
 
ShortString palGetShortAuditLine
 Gets a short audit line
 

Directories
Boolean palDataDirs
 Returns data dirs in buf
 
Boolean palConfigDirs
 Returns config dirs in buf
 
Boolean palExistingConfigFiles
 Returns config file names in buf
 

License
Boolean palLicenseReadU
 Reads license file in various line formats
 
void palLicenseRegisterGAMS
 Registers a line of the license file
 
ShortString palLicenseGetLLine
 Retrieve a line of the license file
 
void palLicenseRegisterGAMSDone
 Completion of license registration
 
void palLicenseRegisterSystem
 Registers the system to be licensed
 
Boolean palLicenseValidation
 Validates license and returns true on failure
 
AnsiChar palLicenseGetType
 Provides license type character, U(ser), N(etwork), M(achine), or O(ther)
 
Boolean palLicenseGetKeyValue
 Retrieves a value (as string) from a key:value pair in the 6th license line. Returns false if key is not present.
 
Pointer palBlockUsesPort
 Blocks a port in the range [start:start+num] retrieved from uses:num@start. Returns a handle to the blocked socket or null if unsuccessful.
 
Integer palLicenseGetEvalDate
 Return serial day number of GAMS BASE time-limited or eval expiration or maxint if not a time-limited license
 
Integer palLicenseGetMaintDate
 Return serial day number of GAMS BASE maintenance expiration or maxint if a time-limited license
 
Boolean palLicenseSolverCheck
 Checks if system with codes is licensed and returns true on failure uses registered size
 
Boolean palLicenseSolverCheckSizes
 Checks if system with codes is licensed and returns true on failure uses sizes from arguments
 
Boolean palLicenseSolverCheckSizes64
 Checks if system with codes is licensed and returns true on failure uses sizes from arguments
 
Boolean palLicenseCheck
 Checks if system is licensed and returns true on failure
 
Boolean palLicenseCheck64
 Checks if system is licensed and returns true on failure
 
Boolean palLicenseGetMessage
 Retrieves message from license check
 
Boolean palPrintDemoMessage
 Retrieves message about demo usage. Return indicates if message should be printed (true means print)
 
Boolean palLicenseIsGAMSCheckout
 Indicator if model fits in free GAMS limits (demo or community based on the actual license), returns true if that is the case, and false if the model is too big and a check for a license code is in order
 
Boolean palLicenseIsAcademic
 Indicator if license is academic
 
Boolean palLicenseCheckSubSys
 Indicator if subsystem is licensed (true if not licenses)
 
Boolean palLicenseCheckSubX
 Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)
 
ShortString palLicenseGetPlatform
 Get platform code of license
 
Integer palReleaseUsesPort
 Releases previously blocked port. Returns 0 on success.
 
Boolean palStartNetworkSession
 Starts a network session. Returns True on success.
 
Boolean palCloseNetworkSession
 Closes previously opened network session. Returns True on success.
 

Enumerated Constants

 
palModelSizeLimits palLDemo  = 2000
  palNLDemo  = 1000
  palLCommunity  = 5000
  palNLCommunity  = 2500
 

Definitions

palLicenseLevel ↵

Access the license level

Type
Property of type Integer
Action
read

palLicenseLevelSet ↵

Access the license level

Type
Property of type Integer
Action
write

palNetworkLicenseOK ↵

Indicator if validation of network license template is okay

Type
Property of type Boolean
Action
read

palNetworkLicenseOKSet ↵

Indicator if validation of network license template is okay

Type
Property of type Boolean
Action
write

palAuditFields ↵

Chops audit line apart

Type
Procedure
Parameters
  const  ShortString    auditline
     audit line
  out  ShortString    v1
     product part of audit line
  out  ShortString    v2
     distribution info of audit line
  out  ShortString    v3
     rest of audit line

palAuditRun ↵

Indicator for an audit run

Type
Function returns Boolean

palBlockUsesPort ↵

Blocks a port in the range [start:start+num] retrieved from uses:num@start. Returns a handle to the blocked socket or null if unsuccessful.

Type
Function returns Pointer
Parameters
  out  Integer    start
     returns the start of the port block
  out  Integer    num
     returns the length of the port block
  out  Integer    port
     returns the port that has been block if return is not null

palCloseNetworkSession ↵

Closes previously opened network session. Returns True on success.

Type
Function returns Boolean
Parameters
  var  Pointer    msgptr
     pchar to the start of a message buffer in case the function returns false

palConfigDirs ↵

Returns config dirs in buf

Type
Function returns Boolean
Parameters
   PAnsiChar    buf
     buffer to return a number of directories
   Integer    bufsize
     size of buf
  out  Integer    numdirs
     number of directories returned
   PLongIntArray    offset
     vector of offsets into buf to access the individual directories
   Integer    offsetsize
     size of offset vector
  const  ShortString    sysdir
     GAMS system directory

palDataDirs ↵

Returns data dirs in buf

Type
Function returns Boolean
Parameters
   PAnsiChar    buf
     buffer to return a number of directories
   Integer    bufsize
     size of buf
  out  Integer    numdirs
     number of directories returned
   PLongIntArray    offset
     vector of offsets into buf to access the individual directories
   Integer    offsetsize
     size of offset vector
  const  ShortString    sysdir
     GAMS system directory

palExistingConfigFiles ↵

Returns config file names in buf

Type
Function returns Boolean
Parameters
   PAnsiChar    buf
     buffer to return a number of file names
   Integer    bufsize
     size of buf
  out  Integer    numfiles
     number of file names returned
   PLongIntArray    offset
     vector of offsets into buf to access the individual file names
   Integer    offsetsize
     size of offset vector
  const  ShortString    sysdir
     GAMS system directory

palGetAuditLine ↵

Gets audit string

Type
Function returns ShortString

palGetBldCod ↵

Gets build code like LEG

Type
Function returns ShortString

palGetCod ↵

Gets Platform code like WIN

Type
Function returns ShortString

palGetCpr ↵

Gets copyright string

Type
Function returns ShortString

palGetGold ↵

Gets Maintenance number like 2 for 23.9.2

Type
Function returns ShortString

palGetHdr ↵

Gets Platform text like x86/MS Windows

Type
Function returns ShortString

palGetJul ↵

Get license check date as serial day number

Type
Function returns Integer

palGetJulianDays ↵

Get serial day number from the string yymmdd

Type
Function returns Integer
Parameters
  const  ShortString    s

palGetLicDat ↵

Gets build date like "Sep 19, 2012"

Type
Function returns ShortString

palGetRel ↵

Gets Major.Minor like 23.9

Type
Function returns ShortString

palGetRelDat ↵

Gets license check date like "Dec 3, 2021 (ALPHA)" or "Dec 3, 2021 "

Type
Function returns ShortString

palGetRevision ↵

Gets global SVN revision number like r123456

Type
Function returns ShortString

palGetShortAuditLine ↵

Gets a short audit line

Type
Function returns ShortString

palGetToday ↵

Get todays date as serial day number

Type
Function returns Integer

palGetVer ↵

Major and Minor number combined as an int like 239

Type
Function returns Integer

palIsAlfa ↵

Indicator for an alpha system (deprecated)

Type
Function returns Boolean

palIsAlpha ↵

Indicator for an alpha system

Type
Function returns Boolean

palIsBeta ↵

Indicator for an beta system

Type
Function returns Boolean

palLicenseCheck ↵

Checks if system is licensed and returns true on failure

Type
Function returns Boolean
Parameters
   Integer    M
     number of equations
   Integer    N
     number of variables
   Integer    NZ
     number of non-zeros
   Integer    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseCheck64 ↵

Checks if system is licensed and returns true on failure

Type
Function returns Boolean
Parameters
   Integer    M
     number of equations
   Integer    N
     number of variables
   Int64    NZ
     number of non-zeros
   Int64    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseCheckSubSys ↵

Indicator if subsystem is licensed (true if not licenses)

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system

palLicenseCheckSubX ↵

Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)

Type
Function returns Boolean
Parameters
  const  ShortString    sname
     name of solver/subsystem
  const  ShortString    codes
     license codes for system
  var  Integer    daysLeft
     remaining days of eval license (negative if expired)

palLicenseGetEvalDate ↵

Return serial day number of GAMS BASE time-limited or eval expiration or maxint if not a time-limited license

Type
Function returns Integer

palLicenseGetKeyValue ↵

Retrieves a value (as string) from a key:value pair in the 6th license line. Returns false if key is not present.

Type
Function returns Boolean
Parameters
  const  ShortString    key
     key
  out  ShortString    sval
     value

palLicenseGetLLine ↵

Retrieve a line of the license file

Type
Function returns ShortString
Parameters
   Integer    linenr
     license file line number

palLicenseGetMaintDate ↵

Return serial day number of GAMS BASE maintenance expiration or maxint if a time-limited license

Type
Function returns Integer

palLicenseGetMessage ↵

Retrieves message from license check

Type
Function returns Boolean
Parameters
  out  ShortString    msg
     message

palLicenseGetPlatform ↵

Get platform code of license

Type
Function returns ShortString

palLicenseGetType ↵

Provides license type character, U(ser), N(etwork), M(achine), or O(ther)

Type
Function returns AnsiChar

palLicenseIsAcademic ↵

Indicator if license is academic

Type
Function returns Boolean

palLicenseIsGAMSCheckout ↵

Indicator if model fits in free GAMS limits (demo or community based on the actual license), returns true if that is the case, and false if the model is too big and a check for a license code is in order

Type
Function returns Boolean

palLicenseReadU ↵

Reads license file in various line formats

Type
Function returns Boolean
Parameters
  const  ShortString    filename
     name of the license file to read
  out  ShortString    msg
     message
  var  Integer    rc
     return code

palLicenseRegisterGAMS ↵

Registers a line of the license file

Type
Procedure
Parameters
   Integer    linenr
     license file line number
  const  ShortString    liceline
     license file line

palLicenseRegisterGAMSDone ↵

Completion of license registration

Type
Procedure

palLicenseRegisterSystem ↵

Registers the system to be licensed

Type
Procedure
Parameters
   Integer    numcodes
     number of license codes for system
  const  ShortString    codes
     license codes for system
   Integer    magicnum
     magic number

palLicenseSolverCheck ↵

Checks if system with codes is licensed and returns true on failure uses registered size

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system

palLicenseSolverCheckSizes ↵

Checks if system with codes is licensed and returns true on failure uses sizes from arguments

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system
   Integer    M
     number of equations
   Integer    N
     number of variables
   Integer    NZ
     number of non-zeros
   Integer    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseSolverCheckSizes64 ↵

Checks if system with codes is licensed and returns true on failure uses sizes from arguments

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system
   Integer    M
     number of equations
   Integer    N
     number of variables
   Int64    NZ
     number of non-zeros
   Int64    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseValidation ↵

Validates license and returns true on failure

Type
Function returns Boolean

palPrintDemoMessage ↵

Retrieves message about demo usage. Return indicates if message should be printed (true means print)

Type
Function returns Boolean
Parameters
  out  ShortString    msg
     message

palReleaseUsesPort ↵

Releases previously blocked port. Returns 0 on success.

Type
Function returns Integer
Parameters
   Pointer    socketptr
     the pointer to the block socket

palSetAuditLine ↵

Sets audit string

Type
Procedure
Parameters
  const  ShortString    auditline
     audit line

palSetSystemName ↵

Sets system name and sets up a generic audit string

Type
Procedure
Parameters
  const  ShortString    sname
     name of solver/subsystem

palStartNetworkSession ↵

Starts a network session. Returns True on success.

Type
Function returns Boolean
Parameters
  var  Pointer    msgptr
     pchar to the start of a message buffer in case the function returns false
  var  Pointer    licptr
     pchar to the start of the instantiated network license in case of success