k_status.h

Go to the documentation of this file.

/*
 * k_status.h
 *
 * (c) 1992-96 Sassafras Software Inc.
 */

#define scDetachable 0x00000001  /* key can be reclaimed by KeyServer without affecting program */
#define scHaveKey    0x00000080  /* key is valid and held by client */

#define keyOldClientErr 9507     /* the client software is too old to get a key for this program */
#define keyNotKeyedErr  9520     /* returned by KeyStatus if the indicated program is not keyed */
#define keyNoClientErr  -1       /* KeyAccess not installed or not running (generated by glue) */

int pascal KeyStatus (long keyRef, long FAR *flags, long FAR *foreTime);
int pascal KeyIntfS4200 (void);

/*
 int pascal KeyStatus (long keyRef, long FAR *flags, long FAR *foreTime);

 DESCRIPTION

   This function checks the status of any keyed program, or
   indicates that the calling program is not keyed.

 PARAMETERS

   keyRef      [in]     reference for the keyed program,
                     or zero for current program.
   flags    [out]    service class.  See above bits
                     for details (scDetachable, etc.)
   foreTime [out]    number of seconds that the keyed
                     program has been in foreground.

 USAGE

   long flags;
   long foreTime;

   err = KeyStatus(0, &flags, &foreTime);

   Call KeyStatus to check whether a program is keyed, and if so,
   what the status of the key is.  If the program is not keyed,
   KeyStatus returns keyNotKeyedErr, keyOldClientErr, keyNoClientErr,
   or some other negative error code.  On noErr, the status of the
   key is returned in flags, and the time that the program has
   spent running in the foreground is returned in foreTime.

   The status flags can be used to determine whether the key for a
   keyed program has been invalidated, and what type of services
   are activated for the keyed program.  The most interesting flags
   are the scDetachable and scHaveKey flags, which reflect the
   validity of the key.  If scHaveKey is clear, then the keyed
   program is no longer running with KeyServerÍs permission.  This
   normally means that the user has been asked to quit from the
   keyed program because of a network failure, because the key
   timed out, or because the KeyServer administrator reclaimed the
   key.  However, if the KeyServer administrator has made the key
   detachable, the user should still be allowed to run the keyed
   program.  This option is usually set for programs that are site
   licensed, or have an infinite number of keys available.

   In order to use this routine, you will need to link k_status.lib
   with your other object code.  To guarantee you are using the
   proper version of this object code file, use the KeyIntfS4200()
   routine.


 int pascal KeyIntfS4200 (void);

 DESCRIPTION

   This function provides a means of version control for the
   k_status.lib object library.

 USAGE

   err = KeyIntfS4200();

   To make sure that the interface file you use matches the object
   file, include one call, anywhere in your code, to the KeyIntfS3100
   routine.  If the object library does not support the proper version
   of the KeyStatus routine, you will get a link-time error, telling
   you that KeyIntfS3100 is not defined.  In this case, you should
   locate the proper version of k_status.lib, and include it in your
   link process.

   When you build your program for the final release, you can remove
   the call to KeyIntfS3100.  There is very little overhead to leaving
   it in the final code, but sometimes every byte counts.  The only
   real error conditions stemming from this function will happen at
   program link time.

*/

---