home *** CD-ROM | disk | FTP | other *** search
/ Mundo do CD-ROM 2 / CDROM02.iso / win95 / clockman / wilcmds.txt < prev   
Encoding:
Text File  |  1996-08-26  |  7.7 KB  |  196 lines
  1. NEW WIL COMMANDS
  2. ================
  3. These commands are available to any WIL script when run from ClockMan95.
  4. (They aren't available if you run the same script file from WinBatch.)
  5.  
  6. /****************************************************************************/
  7. szList = CMEvtItemize (@CMFirst)
  8.  
  9. Creates a space-delimited list of the ClockMan events.
  10.  
  11. Parameters:
  12.     (number)    Which events to itemize:
  13.                     @CMFirst itemizes all events starting with the first one.
  14.                     (This is currently the only value ClockMan recognizes.)
  15.  
  16. Returns:
  17.     (string)    A space-delimited list of all event IDs in ClockMan's
  18.                 database.
  19.  
  20. After calling CMEvtItemize(), you'd normally loop through the returned list
  21. using ItemExtract() to get each event ID in the string. You use this event ID
  22. to get or set information about the event.
  23.  
  24. See Also:
  25.     CMGetEvtInfo, CMSetEvtInfo
  26.  
  27.  
  28. /****************************************************************************/
  29. sInfo = CMGetEvtInfo (nEventID, nWhichInfo)
  30. nInfo = CMGetEvtInfo (nEventID, nWhichInfo)
  31.  
  32. Extracts information about an event.
  33.  
  34. Parameters:
  35.     (number)    Which event to get information on. @CMThisEvt gets info about
  36.                 the event that launched this WIL script.
  37.     (number)    Which piece of information to return:
  38.                 @CMEvtTime - When this event occurred, in WIL datetime fmt.
  39.                 @CMIsActive - Will this event ever occur again?
  40.                 @CMMsgType - One of these:
  41.                     @CMMsgAnn - Simple announcement box.
  42.                     @CMMsgCfm - Confirmation box.
  43.                     @CMMsgCount - Countdown box.
  44.                     @CMMsgTSquare - TimeSquare(tm).
  45.                     @CMMsgNone - No message.
  46.                 @CMMsg - The message text to display.
  47.                 @CMTune - Whether the "Beep" box is checked. @TRUE or @FALSE.
  48.                 @CMTuneName
  49.                 @CMAction - Which action this event carries out. One of these:
  50.                     @CMACMsgOnly - Just a message box.
  51.                     @CMACRunPgm - Run a program.
  52.                     @CMACRunWIL - Run a WIL script.
  53.                     @CMACExitWin - Exit windows.
  54.                     @CMACShutdown - Shutdown the computer.
  55.                     @CMACRestart - Restart the computer.
  56.                     @CMACAdj - Adjust the system time up or down.
  57.                 @CMPgmLine - The full command line to execute.
  58.                 @CMPgmShowAs - How to show the program we launch.
  59.                 @CMPgmKeys - The keystrokes to send to the program.
  60.                 @CMAdjSecs - How many seconds to adjust the time. (Negative
  61.                 number implies adjusting backwards; positive is forwards.)
  62.  
  63. Returns:
  64.     (string)    if @CMNextTime, @CMMsg, @CMTuneName, @CMPgmLine, or @CMPgmKeys.
  65.     (number)    if @CMIsActive, @CMMsgType, @CMTune, @CMAction, @CMPgmShowAs,
  66.                 or @CMAdjSecs.
  67.  
  68. This function returns either a string or an integer value, depending on which
  69. piece of information you specified.
  70.  
  71. See Also:
  72.     CMSetEvtInfo
  73.  
  74.     
  75. /****************************************************************************/
  76. sDesc = CMGetTimeDesc (@CMTimeNow, sFmt)
  77.  
  78. Lets you build a custom date & time string using replacement variables.
  79.  
  80. Parameters:
  81.     (string)    The time to convert to a string, or @CMTimeNow for the current
  82.                 time. (This function currently only recognizes @CMTimeNow.)
  83.     (string)    The format to use in converting the time. You use these 
  84.                 replacement variables:
  85.                 &dt - Windows-defined short date
  86.                 &y4 - 4-digit year
  87.                 &yy - 2-digit year
  88.                 &MO - Full month name ("January".."December")
  89.                 &mo - Abbreviated month ("Jan".."Dec")
  90.                 &mm - Month of year w/o leading zeros ("1".."12")
  91.                 &0m - Month of year w/leading zero if necessary ("01".."12")
  92.                 &DA - Day of week ("Sunday".."Saturday")
  93.                 &da - Abbreviated DOW ("Sun".."Sat")
  94.                 &dd - Day of month w/o leading zeros ("1".."31")
  95.                 &0d - Day of month w/leading zero if necessary ("01".."31")
  96.                 &hr - Hour of day ("0".."24")
  97.                 &0h - Hour w/leading zero if necessary ("00".."24")
  98.                 &mi - Minute ("0".."59")
  99.                 &se - Second ("0".."59")
  100.  
  101. Returns:
  102.     (string)    Your custom date & time string.
  103.  
  104. This command creates a custom date & time description string using the same
  105. syntax you use to customize the ClockMan icon's title.
  106.  
  107. Example:
  108.     szNow = CMGetTimeDesc (@CMTimeNow, "It is now &hr:&mi on &DA, &MO &dd")
  109.     sets szNow to "It is now 15:37 on Monday, August 15".
  110.     
  111.  
  112. /****************************************************************************/
  113. nInfo = CMGetTimeInfo (sTime, nWhichInfo)
  114.  
  115. Returns information about a specified time.
  116.  
  117. Parameters:
  118.     (string)    The time to get information about, in WIL "datetime" format
  119.                 ("yy:mm:dd:hh:mi:ss").
  120.     (number)    Which piece of information to get from it:
  121.                     @CMYear - The year (00..99)
  122.                     @CMMonth - The month (1..12)
  123.                     @CMDayOfMonth - The day of month (1..31)
  124.                     @CMDayOfWeek - The day of the week (0-Sun..6-Sat)
  125.                     @CMHour - The hours (0..11)
  126.                     @CMMinute - The minutes (0..59)
  127.                     @CMSecond - The seconds (0..59)
  128.  
  129. Returns:
  130.     (number)    The information requested above.
  131.  
  132. See Also:
  133.     CMSetTimeInfo
  134.  
  135.  
  136. /****************************************************************************/
  137. CMLogMessage (sMessage)
  138.  
  139. Writes a message out to CLOCKMAN.LOG.
  140.  
  141. Parameters:
  142.     (string)    The message to write out, up to 256 characters.
  143.  
  144. This command writes out the current date & time, and then the message you
  145. specify. The log file name is the same as the current .ALR file, except with
  146. a .LOG extension. This is usually CLOCKMAN.LOG.
  147.  
  148.     
  149. /****************************************************************************/
  150. CMSetEvtInfo (nEventID, nWhich, nData)
  151. CMSetEvtInfo (nEventID, nWhich, sData)
  152.  
  153.  
  154. Parameters:
  155.     (number)        Event identifier. (See CMGetEvtInfo)
  156.     (number)        Which piece of data to set. (See CMGetEvtInfo)
  157.     (number) or (string)
  158.                     The new data. It's a string if setting @CMEvtTime, @CMMsg,
  159.                     @CMTuneName, @CMPgmLine, or @CMPgmKeys; it's a number if
  160.                     setting @CMMsgType, @CMTune, @CMAction, @CMPgmShowAs, or
  161.                     @CMAdjSecs.
  162.  
  163. Note: you can't use @CMIsActive. (When you call CMGetEvtInfo with @CMIsActive,
  164. it merely tells you if the event will ever occur again. This depends on
  165. whether it's a recurring or a one-time event, and whether or not this one time
  166. is set in the future or in the past.)
  167.  
  168. See Also:
  169.     CMGetEvtInfo
  170.  
  171.  
  172. /****************************************************************************/
  173. sNewTime = CMSetTimeInfo (sOldTime, nWhichInfo, nData)
  174.  
  175. Changes specific parts of a WIL "datetime" string.
  176.  
  177. Parameters:
  178.     (string)    The time to change information about, in WIL "datetime" format
  179.                 ("yy:mm:dd:hh:mi:ss").
  180.     (number)    Which info to change:
  181.     (number)    Which piece of information to change:
  182.                     @CMYear - The year (00..99)
  183.                     @CMMonth - The month (1..12)
  184.                     @CMDayOfMonth - The day of month (1..31)
  185.                     @CMHour - The hours (0..11)
  186.                     @CMMinute - The minutes (0..59)
  187.                     @CMSecond - The seconds (0..59)
  188.  
  189. Returns:
  190.     (string)    The time in WIL "datetime" format, with the appropriate data
  191.                 changed.
  192.  
  193. See Also:
  194.     CMGetTimeInfo
  195.  
  196.