home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: OtherApp / OtherApp.zip / stwtv113.zip / RexxApi.TXT < prev    next >
Text File  |  1999-11-13  |  9KB  |  286 lines
  1. Rexx-Scripts under StWTV can call the following functions:
  2. ********************************************************************************
  3. Function:   StWTVGetVersion
  4. Since:      Bld 2140
  5. Purpose:    returns the version of StWTV
  6. Parameters: VersionType
  7. Returns:    Requested version information
  8.  
  9. Parameter
  10.  VersionType=FULL (default)
  11.   return full version info string
  12.  VersionType=VERSION
  13.   return version number string
  14.  VersionType=BUILD
  15.   return build level string
  16.  
  17. ********************************************************************************
  18. Function:   StWTVEnumStations
  19. Since:      Bld 2140
  20. Purpose:    Enumerates all defined stations or all stations in a toolbar into a
  21.             Stem variable
  22. Parameters: StemVar
  23.             [Toolbarhandle]
  24. Returns:    number of stations in StemVar
  25.  
  26. Parameter:  StemVar
  27.              On return, StemVar.0 contains the number of defined stations.
  28.              StemVar.1 contains the handle of the first station, StemVar.2
  29.              contains the handle of the second station and so on
  30.             Toolbarhandle
  31.              if given, all stations for this toolbar are enumerated. if omitted
  32.              all definded stations are enumerated
  33.  
  34. ********************************************************************************
  35. Function:   StWTVGetStation
  36. Since:      Bld 2140,2215
  37. Purpose:    returns some informations about a station
  38. Parameters: type
  39.             [station]
  40.             [StemVar](required only when type=FULL)
  41. Returns:    requested information. If type=FULL the handle is returned
  42.             If there is no station and type is not HANDLE the script will stop
  43.             If type is HANDLE and there is no station, 0 will be returned
  44.             (eg. while initialisation when there is no station defined)
  45.  
  46. Parameter:
  47.  type=FULL
  48.   returns the handle of the station.
  49.   full station info will be stored in StemVar:
  50.    StemVar.Handle
  51.    StemVar.Name
  52.    StemVar.Signal (only since Bld 2215 !)
  53.    StemVar.Channel
  54.    StemVar.Frequency
  55.    StemVar.Brightness
  56.    StemVar.Contrast
  57.    StemVar.Saturation
  58.    StemVar.Hue
  59.    StemVar.Bitmap
  60.  type=HANDLE
  61.   returns the handle of the station
  62.  type=NAME
  63.   returns the name of the station
  64.  type=SIGNAL (only since Bld 2215 !)
  65.   returns the signal source
  66.  type=CHANNEL
  67.   returns the channel number of the station
  68.  type=FREQUENCY
  69.   returns the frequency of the station
  70.  type=BRIGHTNESS
  71.   returns the brightness of the station
  72.  type=CONTRAST
  73.   returns the contrast of the station
  74.  type=SATURATION
  75.   returns the saturation of the station
  76.  type=HUE
  77.   returns the hue of the station
  78.  type=BITMAP
  79.   returns the name of the bitmap file for the station button
  80.  
  81.  station=CURRENT (default)
  82.   returns the information for the currently active station
  83.  station=PREVIOUS
  84.   returns the information for the previously active station
  85.  station=<numeric value>
  86.   returns the information for the station with the handle <numeric value>
  87.  
  88. ********************************************************************************
  89. Function:   StWTVSetStation
  90. Since:      Bld 2140
  91. Purpose:    sets some settings for a station
  92. Parameters: type
  93.             station
  94.             Var/StemVar (StemVar only when type=FULL)
  95.             [ACTION]
  96. Returns:    Handle of the station.
  97.  
  98. Parameter:
  99.  type=FULL
  100.   full station info will be retreived from StemVar into requested station
  101.    StemVar.Name
  102.    StemVar.Signal (only since Bld 2215 !)
  103.    StemVar.Channel
  104.    StemVar.Frequency
  105.    StemVar.Brightness
  106.    StemVar.Contrast
  107.    StemVar.Saturation
  108.    StemVar.Hue
  109.    StemVar.Bitmap
  110.  type=NAME
  111.   sets the name of the station
  112.  type=SIGNAL (only since Bld 2215 !)
  113.   sets the signal source for the station
  114.  type=CHANNEL
  115.   sets the channel number of the station
  116.  type=FREQUENCY
  117.   sets the frequency of the station
  118.  type=BRIGHTNESS
  119.   sets the brightness of the station
  120.  type=CONTRAST
  121.   sets the contrast of the station
  122.  type=SATURATION
  123.   sets the saturation of the station
  124.  type=HUE
  125.   sets the hue of the station
  126.  type=BITMAP
  127.   sets the name of the bitmap file for the station button
  128.  
  129.  station=CURRENT
  130.   sets the information for the currently active station
  131.  station=PREVIOUS
  132.   sets the information for the previously active station
  133.  station=<numeric value>
  134.   sets the information for the station with the handle <numeric value>
  135.  
  136.  action=SET (default)
  137.   the new values will be set
  138.  action=CREATE
  139.   creates a new station. station will be ignored.
  140.  action=DELETE
  141.   deletes a station
  142.  
  143. ********************************************************************************
  144. Function:   StWTVActivateStation
  145. Since:      Bld 2140
  146. Purpose:    Activates a new station so that it is visible in the TV-Screen
  147. Parameters: Handle
  148.  
  149. Returns:    Handle
  150.  
  151. Parameter:
  152.  Handle
  153.   handle of the station
  154.  
  155. ********************************************************************************
  156. Function:   StWTVEnumToolbars
  157. Since:      Bld 2140
  158. Purpose:    Enumerates all defined station toolbars into a Stem variable
  159. Parameters: <StemVar>
  160. Returns:    number of toolbars in StemVar
  161.  
  162. Parameter:  StemVar
  163.              On return, StemVar.0 contains the number of defined toolbars.
  164.              StemVar.1 contains the handle of the first toolbar, StemVar.2
  165.              contains the handle of the second toolbar and so on
  166.  
  167. ********************************************************************************
  168. Function:   StWTVGetToolbar
  169. Since:      Bld 2140
  170. Purpose:    returns some informations about a toolbar
  171. Parameters: type
  172.             toolbar
  173.             [StemVar](required only when type=FULL)
  174. Returns:    requested information. If type=FULL the handle is returned
  175.             If there is no toolbar and type is not HANDLE the script will stop
  176.             If type is HANDLE and there is no toolbar, 0 will be returned
  177.             (eg. while initialisation when there is no toolbar defined)
  178.  
  179. Parameter:
  180.  type=FULL
  181.   returns the handle of the toolbar
  182.   full toolbar info will be stored in StemVar:
  183.    StemVar.Handle
  184.    StemVar.Name
  185.    StemVar.Location
  186.    StemVar.Position
  187.    StemVar.NumOfStationsPerLine
  188.    StemVar.NumStations
  189.  type=HANDLE
  190.   returns the handle of the station
  191.  type=NAME
  192.   returns the name of the station
  193.  type=LOCATION
  194.   returns TOP, BOTTOM, LEFT, RIGHT, FLOATING or HIDDEN
  195.  type=POSITION
  196.   returns the position of the toolbar in the form x;y
  197.  type=NUMSTATIONSPERLINE
  198.   returns max. number of stations per line
  199.  type=NUMSTATIONS
  200.   returns the number of stations defined in this toolbar
  201.  
  202. ********************************************************************************
  203. Function:   StWTVSetToolbar
  204. Since:      Bld 2140
  205. Purpose:    sets some settings for a toolbar
  206. Parameters: type
  207.             toolbar
  208.             Var/StemVar (StemVar only when type=FULL)
  209.             [ACTION]
  210. Returns:    Handle of the toolbar
  211.  
  212. Parameter:
  213.  type=FULL
  214.   full toolbar info will be retreived from StemVar into requested toobar
  215.    StemVar.Name
  216.    StemVar.Location
  217.    StemVar.Position
  218.    StemVar.NumOfStationsPerLine
  219.  type=NAME
  220.   sets the name of the station
  221.  type=LOCATION
  222.   sets the new location
  223.  type=POSITION
  224.   sets the new position (format must be x;y )
  225.  type=NUMSTATIONSPERLINE
  226.   sets max. number of stations per line
  227.  
  228.  action=SET (default)
  229.   the new values will be set
  230.  action=CREATE
  231.   creates a new toolbar. toolbar will be ignored.
  232.  action=DELETE
  233.   deletes a toolbar
  234.  
  235. ********************************************************************************
  236. Function:   StWTVAddStation
  237. Since:      Bld 2140
  238. Purpose:    adds a station to a toolbar
  239. Parameters: station
  240.             toolbar
  241. Returns:    Handle of the toolbar
  242.  
  243. Parameter:
  244.  station= station handle to add
  245.           CURRENT = current active station
  246.           PREVIOUS = previous active station
  247.  
  248.  toolbar= toolbar handle to add to
  249.  
  250. ********************************************************************************
  251. Function:   StWTVRemoveStation
  252. Since:      Bld 2140
  253. Purpose:    removes a station from a toolbar
  254. Parameters: station
  255.             toolbar
  256. Returns:    Handle of the toolbar
  257.  
  258. Parameter:
  259.  station= station handle to add
  260.           CURRENT = current active station
  261.           PREVIOUS = previous active station
  262.  
  263.  toolbar= toolbar handle to remove from
  264.  
  265.  
  266. ********************************************************************************
  267. Function:   StWTVShutDown
  268. Since:      Bld 2186
  269. Purpose:    ends StWTV. A Close request is posted to the StWTV main window. So
  270.             this function call returns, while StWTV is still running. After
  271.             finishing the script, StWTV will shutdown
  272. Parameters: 
  273. Returns:    Nothing
  274. Parameter:
  275.  
  276. ********************************************************************************
  277. Function:   StWTVSetDriverVar
  278. Since:      Bld 3002
  279. Purpose:    Sets a driver specific variable
  280. Parameters: varName
  281.             varValue
  282. Returns:    Nothing
  283. Parameter:  varName = The name of the driver variable
  284.             varValue = Value to set
  285.  
  286.