Copyright Digital Equipment Corp. All rights reserved.

Arguments

 

handle-address

   OpenVMS usage:address
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Block of storage containing the value returned by a previous call
   to LIB$INIT_TIMER. The handle-address argument is the address of
   an unsigned longword integer containing that value.

   o  If specified, the pointer must be the same value returned by a
      previous call to LIB$INIT_TIMER.

   o  If omitted, LIB$SHOW_TIMER will use a block of memory
      allocated by LIB$INIT_TIMER.

   o  If handle-address is omitted and LIB$INIT_TIMER has not
      been called previously, the error LIB$_INVARG is returned.
      LIB$INIT_TIMER must be called prior to a call to LIB$SHOW_
      TIMER. Note that the handle-address argument is the same as
      the context argument used in the LIB$INIT_TIMER call.

   LIB$SHOW_TIMER assumes that LIB$INIT_TIMER has been previously
   called, and that the results of that call are stored either in a
   block pointed to by handle-address, or in the memory allocated by
   LIB$INIT_TIMER.
 

code

   OpenVMS usage:longword_signed
   type:         longword (signed)
   access:       read only
   mechanism:    by reference

   Integer specifying the statistic you want; if it is omitted or
   zero, all five statistics are returned on one line. The code
   argument is the address of a signed longword integer containing
   the statistic code.

   The following values are allowed for the code argument:

   Value Description

   1     Elapsed time
   2     CPU time
   3     Buffered I/O
   4     Direct I/O
   5     Page faults
 

user-action-procedure

   OpenVMS usage:procedure
   type:         procedure value
   access:       function call (before return)
   mechanism:    by value

   User-supplied action routine called by LIB$SHOW_TIMER. The
   default action of LIB$SHOW_TIMER is to write the results to
   SYS$OUTPUT. An action routine is useful if you want to write the
   results to a file or, in general, anywhere other than SYS$OUTPUT.

   The action routine returns either a success or failure condition
   value; this status is returned to the calling program as the
   value of LIB$SHOW_TIMER.
 

user-argument-value

   OpenVMS usage:user-arg
   type:         longword (unsigned) (on VAX systems)
                             quadword (unsigned) (on Alpha and I64
                 systems)
   access:       read only
   mechanism:    by value

   A value to be passed to the action routine without
   interpretation. If omitted, LIB$SHOW_TIMER passes a zero by value
   to the user routine.