CT_WaitPeriod()

  NAME
       WaitPeriod()
  CATEGORY
       HBCT date and time functions
  ONELINER
       Pauses a specified time in increments of 1/100 seconds
  SYNTAX
       WaitPeriod( [<nDelay>] ) --> lNotElapsed
  ARGUMENTS
     <nDelay>  Designates the waiting period at initialization in
     1/100ths of seconds.  Values from 1 to 8,640,000 (one day) are
     possible.
  RETURNS
     WaitPeriod() returns .T., if the time span designated at initialization
     has not elapsed.
  DESCRIPTION
     This function sets a time span for a DO WHILE loop to run.
     The function must initialize prior to the loop, since you must specify
     the <nDelay> parameter in 1/100th seconds.  Subsequently, the function
     can be implemented without a parameter for additional loop conditions.
     It returns .T., as long as the designated time span has not yet run out.
  Note :
     The function notes the status of the internal timer at
     initialization.  From that point on, the initialization should always
     precede the respective DO WHILE; otherwise, the time delay is
     incorrect.  The passing of midnight (the time resets to the 0 value)
     is taken into account.
  EXAMPLES
     // Run a loop for 5 seconds:
     WaitPeriod( 500 )             // Initialization, 5 seconds
     DO WHILE <cond1> .AND. <cond2> .AND. WaitPeriod()
        // ...
     ENDDO

  STATUS
     Ready

  COMPLIANCE

     WaitPeriod() is Clipper Tools compatible.

  PLATFORMS

     All

  FILES

     Library is hbct.
     


Tools — Date/Time Functions

Introduction Date/Time Functions
ADDMONTH()   Adds or subtracts months to/from a date
BOM()        Determines the date of the first day of a month
BOQ()        Determines the date for the beginning of a quarter
BOY()        Determines the date for the beginning of a year
CTODOW()     Converts the day of the week name into a corresponding number
CTOMONTH()   Converts the name of the month into a corresponding number
DMY()        Returns a date in "DD Month YY" format
DOY()        Determines the day of the year for a specific date
EOM()        Determines the date for the last day of a month
EOQ()        Determines the date for the end of a quarter
EOY()        Determines the date for the end of the year
ISLEAP()     Tests if a specific year is a leap year
LASTDAYOM()  Determines the number of days in a month
MDY()        Returns a date in the "Month DD, YY" format
NTOCDOW()    Changes the number of a weekday into a weekday name
NTOCMONTH()  Changes the number of a month into a month name
QUARTER()    Determines the quarter in which a specific date lies
SECTOTIME()  Converts seconds into a time string
SETDATE()    Sets the system date
SETTIME()    Sets the system clock
SHOWTIME()   Continuously displays the time at desired screen position
STOD()       Converts an ANSI date string into Clipper format
TIMETOSEC()  Calculates the seconds since midnight
TIMEVALID()  Determines whether a specified time is valid
WAITPERIOD() Pauses a specified time in increments of 1/100 seconds
WEEK()       Returns the calendar week for a date
WOM()        Returns the week within a month.