VkFLM(3x)

NAME
     VkFLM - FLEXlm License Management

HEADER FILE
     #include <Vk/VkFLM.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkFLM( VENDORCODE*, char *, char *, char *, long );

           void ~VkFLM (void);


X RESOURCES ASSOCIATED WITH THIS CLASS
           enterLicenseMessage
           disableLicenseWarnings
           disableThirtyDayLicenseWarnings
           thirtyDayMessage
           sixtyDayMessage
           ninetyDayMessage
           noLicenseMessage
           noLicenseServerMessage
           notEnoughLicensesMessage
           licenseExpiredMessage
           loseLicenseMessage
           warnLoseLicenseMessage
           regainLicenseMessage


CLASS DESCRIPTION
          VkFLM provides a high-level interface to the FLEXlm network
          licensing manager.  The VkFLM class implements a policy based on the
          FLEXlm license mechanism that simplifies the process of license
          protecting applications.  Applications merely instantiate a VkFLM
          object in their application, providing some basic information about
          the application and its licensing.  The VkFLM object handles all
          license verification, informing the user if there is a problem, and
          shutting the application down if a license cannot be found.

          VkFLM will look for either a node-locked or network (concurrent)
          license.  There is no difference to the application for these
          different types of licenses.  Once the VkFLM object is instantiated,
          the object immediately checks for a valid license.  If no license is
          found, the object posts a fatal error dialog, which the user must
          dismiss, exiting the application.

          If a license is obtained, the license is rechecked every ten
          minutes.  If the application's license is lost, a warning dialog is
          posted warning that the license is no longer valid.  This dialog is
          posted in blocking mode, so the user must dismiss it, however, the
          application will not exit.  Instead, the object begins checking
          every minute for a license.  If the license is restored, a dialog is
          posted notifying the user, and the program returns to normal
          operation.  If the license is not found, another blocking dialog is
          posted every minute.

          The VkFLM class also supports warnings for users whose licenses are
          about to expire.  By default, VkFLM will post a warning when a
          license has less than 90 days before expiration.

RESOURCES
     VkFLM recognizes several X resources that control the messages posted by
     the various dialogs.  These are:

   enterLicenseMessage
     If there is an entry in the license file that is valid except for the
     password, the user will be prompted to supply a valid password.  This
     resource is the prompt that will be displayed when the password is
     requested.  It is usual to put the full name and version number of the
     product in the prompt.

   disableLicenseWarnings
     If TRUE, don't show the warnings that appear when a license has only 90
     days before expiration.  The default is FALSE.  This resource does not
     disable messages when the license has less than 30 days before
     expiration.

   disableThirtyDayLicenseWarnings
     If TRUE, don't show the warnings that appear when a license has only 30
     days before expiration.  The default is FALSE.

   thirtyDayMessage
     Determines the message to appear when only 30 days or less are left
     before a license expires.  The message is expected to embed a "%d"
     printf-style integer spec in the message.  VkFLM will plug the correct
     number of days into this slot.  For example:

          *thirtyDayMessage: Your license will expire in %d days.


   sixtyDayMessage
     Determines the message to appear when between 60 and 30 days are left
     before a license expires.  The message is expected to embed a "%d"
     printf-style integer spec in the message.  VkFLM will plug the correct
     number of days into this slot.

   ninetyDayMessage
     Determines the message to appear when between 90 and 60 days are left
     before a license expires.  The message is expected to embed a "%d"
     printf-style integer spec in the message.  VkFLM will plug the correct
     number of days into this slot.

   noLicenseMessage
     Determines the message to appear when no valid license can be found.

   notEnoughLicensesMessage
     Determines the message to appear when an application is licensed, but
     there are not enough licenses currently available to support the number
     of people using them.

   licenseExpiredMessage
     Determines the message to appear when an application has had a valid
     license, but the license has now expired.

   warnLoseLicenseMessage
     Determines the message to appear when an application has lost its license
     while the application is running.

   loseLicenseMessage
     Determines the message to appear when an application has lost its license
     and is unable to regain the license.

   regainLicenseMessage
     Determines the message to appear when an application that has lost its
     license and has successfully regained the license.

FUNCTION DESCRIPTIONS
   VkFLM()
           VkFLM( VENDORCODE*, char *, char *, char *, long );


          When instantiating a VkFLM object, applications must provide a
          vendor code, the daemon name, the feature name, and the version
          number.  The application may also supply an interval (in minutes)
          for checks to make sure the license is still valid.

   ~VkFLM()
          void ~VkFLM(void);


          Free all storage associated with a VkFLM object and return any
          license currently in use.

SEE ALSO
     FLEXlm End User Manual, ViewKit Programmer's Guide.