home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / psnsrexx.zip / PSNSREXX.INF (.txt) < prev   
OS/2 Help File  |  2000-07-05  |  245KB  |  11,341 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Notices ΓòÉΓòÉΓòÉ
  3.  
  4. References in this publication to IBM products, programs or services do not 
  5. imply that IBM intends to make these available in all countries in which IBM 
  6. operates. Any reference to an IBM product, program, or service is not intended 
  7. to state or imply that only IBM's product, program, or service may be used. Any 
  8. functionally equivalent product, program, or service that does not infringe any 
  9. of IBM's intellectual property rights may be used instead of the IBM product, 
  10. program, or service. Evaluation and verification of operation in conjunction 
  11. with other products, except those expressly designated by IBM, is the user's 
  12. responsibility. 
  13.  
  14. IBM may have patents or pending patent applications covering subject matter in 
  15. this document. The furnishing of this document does not give you any license to 
  16. these patents. 
  17.  
  18.  
  19. ΓòÉΓòÉΓòÉ 1.1. Copyright notices ΓòÉΓòÉΓòÉ
  20.  
  21. (C) Copyright International Business Machines Corporation 1995, 1997, 1998. All 
  22. rights reserved. 
  23.  
  24. Note to U.S. Government Users - Documentation related to restricted rights - 
  25. Use, duplication or disclosure is subject to restrictions set forth in GSA ADP 
  26. Schedule Contract with IBM Corp. 
  27.  
  28.  
  29. ΓòÉΓòÉΓòÉ 1.2. Trademarks ΓòÉΓòÉΓòÉ
  30.  
  31. For a list of IBM and non-IBM trademarks, refer to the online book Trademarks 
  32. in the Information folder. 
  33.  
  34.  
  35. ΓòÉΓòÉΓòÉ 2. How to use the REXX API ΓòÉΓòÉΓòÉ
  36.  
  37. Before running any of the REXX commands, it is necessary to initialise the DLL, 
  38. so that the commands can be correctly interpreted. A sample of some typical 
  39. code that would appear at the top of a REXX OS/2 Warp Server Backup/Restore 
  40. program is shown below: 
  41.  
  42. Call RxFuncQuery 'PSNSLOADFUNCS'
  43. If result = 1 Then Do
  44. Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  45. If result <> 0 Then Say "Could not load the rexxapi dll"
  46. Exit
  47. End
  48. Call PSNSLOADFUNCS
  49.  
  50. This attempts to load the REXX API (PSNSREXX.DLL), and if successful then the 
  51. individual functions are loaded using the call PSNSLOADFUNCS. 
  52.  
  53. Having done this it is then necessary to use PsnsInit to establish contact with 
  54. the server. The OS/2 Warp Server Backup/Restore REXX API functions can then be 
  55. run. Finally once the desired commands have been run the PsnsTerm command must 
  56. be run in order to disconnect from the server. 
  57.  
  58.  
  59. ΓòÉΓòÉΓòÉ 3. Starting the API server ΓòÉΓòÉΓòÉ
  60.  
  61. To start the API server, you must run the program PSNSD.EXE or double-click on 
  62. its icon in the OS/2 Warp Server Backup/Restore folder.  The syntax of the 
  63. command is as follows: 
  64.  
  65.           ΓöîΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÉ
  66.                                 Γöé
  67. ΓöÇΓöÇPSNSDΓöÇΓö¼ΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓöÇΓö╝ΓöÇΓöÇΓöÇ
  68.           Γöé                      Γöé
  69.           Γö£ΓöÇ/Pipe:<pipename>ΓöÇΓöÇΓöÇΓöÇΓöÇΓöñ
  70.           Γöé                      Γöé
  71.           Γö£ΓöÇ/Port:<servicename>ΓöÇΓöÇΓöñ
  72.           Γöé                      Γöé
  73.           ΓööΓöÇ/Port:<portnumber>ΓöÇΓöÇΓöÇΓöÿ
  74.  
  75.      <pipename> is the name of a named pipe to listen on 
  76.  
  77.      <servicename> is the name of a service which will be looked up in the 
  78.       TCP/IP services file to decide which port to listen on 
  79.  
  80.      <portnumber> is the number of a port to listen on 
  81.  
  82.  The pipe name, service name or port number should be the same as that which 
  83.  will be passed to PsnsInit in the client which is going to connect to the 
  84.  server. 
  85.  
  86.  As many named pipes or TCP/IP ports can be opened as are specified on the 
  87.  command line.  If you specify /Pipe: without a pipe name, a default pipe name 
  88.  will be used.  If you specify /Port: without a port name or service number, 
  89.  the service psnsapi will be looked up in the TCP/IP services file to find out 
  90.  which port to use. 
  91.  
  92.  
  93. ΓòÉΓòÉΓòÉ 4. OS/2 Warp Server Backup/Restore functions ΓòÉΓòÉΓòÉ
  94.  
  95. This section lists the functions available in the OS/2 Warp Server 
  96. Backup/Restore REXX API. 
  97.  
  98.      Initialisation / termination functions 
  99.  
  100.         -  PsnsInit 
  101.         -  PsnsTerm 
  102.  
  103.      Backup method functions 
  104.  
  105.         -  PsnsBackupMethodInfo 
  106.         -  PsnsCopyBackupMethod 
  107.         -  PsnsCreateBackupMethod 
  108.         -  PsnsDeleteBackupMethod 
  109.         -  PsnsEstimateBackupMethod 
  110.         -  PsnsListBackupMethods 
  111.         -  PsnsRenameBackupMethod 
  112.         -  PsnsRunBackupMethod 
  113.  
  114.      Restore method functions 
  115.  
  116.         -  PsnsCopyRestoreMethod 
  117.         -  PsnsCreateRestoreMethod 
  118.         -  PsnsDeleteRestoreMethod 
  119.         -  PsnsEstimateRestoreMethod 
  120.         -  PsnsListRestoreMethods 
  121.         -  PsnsRenameRestoreMethod 
  122.         -  PsnsRestoreMethodInfo 
  123.         -  PsnsRunRestoreMethod 
  124.  
  125.      Backup set functions 
  126.  
  127.         -  PsnsBackupSetInfo 
  128.         -  PsnsCreateBackupSet 
  129.         -  PsnsDeleteBackupSet 
  130.         -  PsnsEmptyBackupSet 
  131.         -  PsnsGetBackupSetConfig 
  132.         -  PsnsGetLogFile 
  133.         -  PsnsListBackupSets 
  134.         -  PsnsSetBackupSetConfig 
  135.         -  PsnsTransferBackupSet 
  136.         -  PsnsTransferIn 
  137.  
  138.      Storage device functions 
  139.  
  140.         -  PsnsCreateStorageDevice 
  141.         -  PsnsDeleteStorageDevice 
  142.         -  PsnsGetStorageDeviceConfig 
  143.         -  PsnsListCreatableStorageDevices 
  144.         -  PsnsListStorageDevices 
  145.         -  PsnsRefreshStorageDevices 
  146.         -  PsnsSetStorageDeviceConfig 
  147.         -  PsnsStorageDeviceInfo 
  148.  
  149.      Volume functions 
  150.  
  151.         -  PsnsActivateVolume 
  152.         -  PsnsAssociateVolume 
  153.         -  PsnsCreateVolume 
  154.         -  PsnsDeleteVolume 
  155.         -  PsnsListVolumeBackupSets 
  156.         -  PsnsListVolumes 
  157.         -  PsnsVolumeInfo 
  158.  
  159.      Schedule event functions 
  160.  
  161.         -  PsnsActivateEvent 
  162.         -  PsnsCopyEvent 
  163.         -  PsnsCreateEvent 
  164.         -  PsnsDeleteEvent 
  165.         -  PsnsEventInfo 
  166.         -  PsnsGetNextEvent 
  167.         -  PsnsListEvents 
  168.  
  169.      File filter functions 
  170.  
  171.         -  PsnsAddFileFilterRule 
  172.         -  PsnsCopyFileFilter 
  173.         -  PsnsCreateFileFilter 
  174.         -  PsnsDeleteFileFilter 
  175.         -  PsnsDeleteFileFilterRule 
  176.         -  PsnsFileFilterInfo 
  177.         -  PsnsFileFilterRuleInfo 
  178.         -  PsnsListFileFilterRule 
  179.         -  PsnsListFileFilters 
  180.         -  PsnsRenameFileFilter 
  181.  
  182.      Rulebook functions 
  183.  
  184.         -  PsnsAddRulebookRule 
  185.         -  PsnsCopyRulebook 
  186.         -  PsnsCreateRulebook 
  187.         -  PsnsDeleteRulebook 
  188.         -  PsnsDeleteRulebookRule 
  189.         -  PsnsListRulebookRule 
  190.         -  PsnsListRulebooks 
  191.         -  PsnsRenameRulebook 
  192.         -  PsnsRulebookInfo 
  193.         -  PsnsRulebookRuleInfo 
  194.  
  195.      Source drive functions 
  196.  
  197.         -  PsnsListSourceDrives 
  198.         -  PsnsRefreshSourceDrives 
  199.         -  PsnsSelectSourceDrive 
  200.         -  PsnsSourceDriveType 
  201.  
  202.      Settings and defaults 
  203.  
  204.         -  PsnsDefaultsInfo 
  205.         -  PsnsListDefaults 
  206.         -  PsnsListSettings 
  207.         -  PsnsSettingsInfo 
  208.  
  209.      File functions 
  210.  
  211.         -  PsnsAddFile 
  212.         -  PsnsBackupFiles 
  213.         -  PsnsDropFiles 
  214.         -  PsnsListFiles 
  215.         -  PsnsPurgeFiles 
  216.         -  PsnsRestoreFiles 
  217.  
  218.      Utility functions 
  219.  
  220.         -  PsnsGetMessageText 
  221.  
  222.  
  223. ΓòÉΓòÉΓòÉ 4.1. PsnsActivateEvent ΓòÉΓòÉΓòÉ
  224.  
  225. Select an item 
  226.  
  227.      Syntax 
  228.      Parameters 
  229.      Returns 
  230.      Remarks 
  231.      Example 
  232.      Related functions 
  233.  
  234.  
  235. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateEvent - Syntax ΓòÉΓòÉΓòÉ
  236.  
  237. /***************************************************/
  238. /* This function activates or deactivates an event */
  239. /* in the scheduler                                */
  240. /***************************************************/
  241.  
  242. Call PsnsActivateEvent handle, eventID, "status"
  243.  
  244.  
  245. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateEvent - Parameters ΓòÉΓòÉΓòÉ
  246.  
  247.  handle 
  248.            Handle returned by PsnsInit 
  249.  
  250.  eventID 
  251.            Event ID of the event to be activated or deactivated. 
  252.  
  253.  "status" 
  254.            Permitted values are: 
  255.  
  256.            ACTIVATE       Activate the event. 
  257.            DEACTIVATE     Deactivate the event. 
  258.  
  259.  
  260. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateEvent - Returns ΓòÉΓòÉΓòÉ
  261.  
  262.       PSNS_OK 
  263.       PSNS_HANDLE_IN_USE 
  264.       PSNS_COMMUNICATIONS_ERROR 
  265.       PSNS_INVALID_HANDLE 
  266.       PSNS_INVALID_EVENT 
  267.       REXX_INVALID_HANDLE 
  268.       REXX_INVALID_PARAMETER 
  269.  
  270.  
  271. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateEvent - Remarks ΓòÉΓòÉΓòÉ
  272.  
  273. Use this function to activate or deactivate an event in the OS/2 Warp Server 
  274. Backup/Restore scheduler. When an event is deactivated, nothing will happen 
  275. when the event's time is reached. This can be useful to temporarily stop a 
  276. scheduled backup happening, for example during a vacation or during system 
  277. maintenance. 
  278.  
  279. status is in quotes to ensure that its case is correct. 
  280.  
  281.  
  282. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateEvent - Related functions ΓòÉΓòÉΓòÉ
  283.  
  284.      PsnsCopyEvent 
  285.  
  286.      PsnsCreateEvent 
  287.  
  288.      PsnsDeleteEvent 
  289.  
  290.      PsnsEventInfo 
  291.  
  292.      PsnsGetNextEvent 
  293.  
  294.      PsnsListEvents 
  295.  
  296.  
  297. ΓòÉΓòÉΓòÉ 4.2. PsnsActivateVolume ΓòÉΓòÉΓòÉ
  298.  
  299. Select an item 
  300.  
  301.      Syntax 
  302.      Parameters 
  303.      Returns 
  304.      Remarks 
  305.      Example 
  306.      Related functions 
  307.  
  308.  
  309. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateVolume - Syntax ΓòÉΓòÉΓòÉ
  310.  
  311. /***************************************************/
  312. /* This function marks a volume as active          */
  313. /* or inactive                                     */
  314. /***************************************************/
  315.  
  316. Call PsnsActivateVolume handle, volumeID, "status"
  317.  
  318.  
  319. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateVolume - Parameters ΓòÉΓòÉΓòÉ
  320.  
  321.  handle 
  322.            Handle returned by PsnsInit 
  323.  
  324.  volumeID 
  325.            Volume ID of the volume to be activated or deactivated. 
  326.  
  327.  "status" 
  328.            Permitted values are: 
  329.  
  330.            ACTIVATE       Activate the volume. 
  331.            DEACTIVATE     Deactivate the volume. 
  332.  
  333.  
  334. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateVolume - Returns ΓòÉΓòÉΓòÉ
  335.  
  336.       PSNS_OK 
  337.       PSNS_HANDLE_IN_USE 
  338.       PSNS_COMMUNICATIONS_ERROR 
  339.       PSNS_INVALID_HANDLE 
  340.       PSNS_INVALID_VOLUME 
  341.       PSNS_FIXED_VOLUME 
  342.       PSNS_INDEX_DISKETTE 
  343.       PSNS_TRANSFERRED_OUT 
  344.       PSNS_IN_USE 
  345.       REXX_INVALID_HANDLE 
  346.       REXX_INVALID_PARAMETER 
  347.  
  348.  
  349. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateVolume - Remarks ΓòÉΓòÉΓòÉ
  350.  
  351. Use this function to mark a volume as available or unavailable. When a volume 
  352. is marked as unavailable (deactivated), OS/2 Warp Server Backup/Restore will 
  353. not ask you for that volume when performing a backup. If you try to restore 
  354. files from a backup set which contains deactivated volumes, you will see a 
  355. warning message and files on the deactivated volumes will not be restored. 
  356.  
  357. status is in quotes to ensure that its case is correct. 
  358.  
  359.  
  360. ΓòÉΓòÉΓòÉ <hidden> PsnsActivateVolume - Related functions ΓòÉΓòÉΓòÉ
  361.  
  362.      PsnsAssociateVolume 
  363.  
  364.      PsnsCreateVolume 
  365.  
  366.      PsnsDeleteVolume 
  367.  
  368.      PsnsListVolumeBackupSets 
  369.  
  370.      PsnsListVolumes 
  371.  
  372.      PsnsVolumeInfo 
  373.  
  374.  
  375. ΓòÉΓòÉΓòÉ 4.3. PsnsAddFile ΓòÉΓòÉΓòÉ
  376.  
  377. Select an item 
  378.  
  379.      Syntax 
  380.      Parameters 
  381.      Returns 
  382.      Remarks 
  383.      Example 
  384.      Related functions 
  385.  
  386.  
  387. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFile - Syntax ΓòÉΓòÉΓòÉ
  388.  
  389. /***************************************************/
  390. /* This function adds a file or group of files to  */
  391. /* the list of files to be backed up, restored or  */
  392. /* dropped manually.                               */
  393. /***************************************************/
  394.  
  395. Call PsnsAddFile handle, "filename"
  396.  
  397.  
  398. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFile - Parameters ΓòÉΓòÉΓòÉ
  399.  
  400.  handle 
  401.            Handle returned by PsnsInit 
  402.  
  403.  "filename" 
  404.            Name of the file to be added to the list. To add all files in a 
  405.            given directory to the list, append a backslash (\) to the directory 
  406.            name. To add all files in a given directory, and all files in all 
  407.            subdirectories beneath that directory, use a filename such as 
  408.            C:\Programs\*\. No other wildcards are allowed in the filename. 
  409.  
  410.  
  411. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFile - Returns ΓòÉΓòÉΓòÉ
  412.  
  413.       PSNS_OK 
  414.       PSNS_HANDLE_IN_USE 
  415.       PSNS_COMMUNICATIONS_ERROR 
  416.       PSNS_INVALID_HANDLE 
  417.       PSNS_INVALID_PATH 
  418.       REXX_INVALID_HANDLE 
  419.  
  420.  
  421. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFile - Remarks ΓòÉΓòÉΓòÉ
  422.  
  423. Use this function to add a file or group of files to the list of files to be 
  424. backed up, restored or dropped. When you have added all the necessary files to 
  425. the list, they can be backed up using PsnsBackupFiles, restored using 
  426. PsnsRestoreFiles, or dropped using PsnsDropFiles. If you choose to cancel the 
  427. operation and not backup or restore the files, call PsnsPurgeFiles to empty the 
  428. list without taking any other action. The list of files in the list can be 
  429. obtained using PsnsListFiles. 
  430.  
  431. If there is a list of files which you commonly back up, you should consider 
  432. using a backup method with a rulebook to back up the files, instead of this 
  433. function. 
  434.  
  435. filename is in quotes to ensure that its case is correct. 
  436.  
  437.  
  438. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFile - Related functions ΓòÉΓòÉΓòÉ
  439.  
  440.      PsnsBackupFiles 
  441.  
  442.      PsnsDropFiles 
  443.  
  444.      PsnsListFiles 
  445.  
  446.      PsnsPurgeFiles 
  447.  
  448.      PsnsRestoreFiles 
  449.  
  450.  
  451. ΓòÉΓòÉΓòÉ 4.4. PsnsAddFileFilterRule ΓòÉΓòÉΓòÉ
  452.  
  453. Select an item 
  454.  
  455.      Syntax 
  456.      Parameters 
  457.      Returns 
  458.      Remarks 
  459.      Example 
  460.      Related functions 
  461.  
  462.  
  463. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFileFilterRule - Syntax ΓòÉΓòÉΓòÉ
  464.  
  465. /***************************************************/
  466. /* This function adds a new rule to a file filter  */
  467. /***************************************************/
  468.  
  469. Call PsnsAddFileFilterRule handle, "stemname",
  470.                            "filefiltname", position
  471.  
  472.  
  473. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFileFilterRule - Parameters ΓòÉΓòÉΓòÉ
  474.  
  475.  handle 
  476.            Handle returned by PsnsInit 
  477.  
  478.  "stemname" 
  479.            The name of the stem in which the information to be added is to be 
  480.            put. 
  481.  
  482.            Stemname parameters which may be used are: 
  483.  
  484.                                0drive
  485.                     Drive letter of file to be included / excluded, or an 
  486.                     asterisk (*) for all drives. 
  487.  
  488.                                0directory
  489.                     Directory to be included / excluded. 
  490.  
  491.                                0pattern
  492.                     Filename(s) to be included / excluded. Wildcards may be 
  493.                     used. 
  494.  
  495.            0subdirectories 
  496.                     Permitted values are: 
  497.  
  498.                     1      Also include / exclude subdirectories in the 
  499.                            specified directory. 
  500.                     0      Do not include / exclude subdirectories. 
  501.  
  502.                                0include
  503.                     Permitted values are: 
  504.  
  505.                     1      Include the specified files. 
  506.                     0      Exclude the specified files. 
  507.  
  508.  "filefiltname" 
  509.            Name of the file filter to which the rule is to be added. 
  510.  
  511.  position 
  512.            This specifies the position where the rule is to be added to the 
  513.            file filter; 1 means add at the beginning, 2 after the first rule 
  514.            and so on. 
  515.  
  516.  
  517. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFileFilterRule - Returns ΓòÉΓòÉΓòÉ
  518.  
  519.       PSNS_OK 
  520.       PSNS_HANDLE_IN_USE 
  521.       PSNS_COMMUNICATIONS_ERROR 
  522.       PSNS_INVALID_HANDLE 
  523.       PSNS_INVALID_FILE_FILTER 
  524.       PSNS_INVALID_DRIVE 
  525.       PSNS_INVALID_PATH 
  526.       PSNS_INVALID_FILENAME 
  527.       PSNS_INVALID_POSITION 
  528.       REXX_INVALID_HANDLE 
  529.  
  530.  
  531. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFileFilterRule - Remarks ΓòÉΓòÉΓòÉ
  532.  
  533. Use this function to add a new rule to a file filter. The rules are applied in 
  534. order, from first to last, to decide which files will be backed up. You can add 
  535. the new rule in any position before the 'last' rule. See File filters for more 
  536. information about the 'last' rule. 
  537.  
  538. stemname and filefiltname are in quotes to ensure that their cases are correct. 
  539.  
  540.  
  541. ΓòÉΓòÉΓòÉ <hidden> PsnsAddFileFilterRule - Related functions ΓòÉΓòÉΓòÉ
  542.  
  543.      PsnsDeleteFileFilterRule 
  544.  
  545.      PsnsFileFilterRuleInfo 
  546.  
  547.      PsnsListFileFilterRule 
  548.  
  549.  
  550. ΓòÉΓòÉΓòÉ 4.5. PsnsAddRulebookRule ΓòÉΓòÉΓòÉ
  551.  
  552. Select an item 
  553.  
  554.      Syntax 
  555.      Parameters 
  556.      Returns 
  557.      Remarks 
  558.      Example 
  559.      Related functions 
  560.  
  561.  
  562. ΓòÉΓòÉΓòÉ <hidden> PsnsAddRulebookRule - Syntax ΓòÉΓòÉΓòÉ
  563.  
  564. /***************************************************/
  565. /* This function adds a new rule to a rulebook     */
  566. /***************************************************/
  567.  
  568. Call PsnsAddRulebookRule handle, "stemname",
  569.                          "rulebookName", position
  570.  
  571.  
  572. ΓòÉΓòÉΓòÉ <hidden> PsnsAddRulebookRule - Parameters ΓòÉΓòÉΓòÉ
  573.  
  574.  handle 
  575.            Handle returned by PsnsInit 
  576.  
  577.  "stemname" 
  578.            The name of the stem in which the information to be added is to be 
  579.            put. 
  580.  
  581.            Stemname parameters which may be used are: 
  582.  
  583.                                0drive
  584.                     Drive letter to include / exclude, or an asterisk (*) for 
  585.                     all drives. 
  586.  
  587.                                0directory
  588.                     Directory to include / exclude. 
  589.  
  590.                                0pattern
  591.                     Filename(s) to be included / excluded. Wildcards may be 
  592.                     used. 
  593.  
  594.            0subdirectories 
  595.                     Permitted values are: 
  596.  
  597.                     1      Also include / exclude subdirectories in the 
  598.                            specified directory. 
  599.                     0      Do not include / exclude subdirectories. 
  600.  
  601.                                0generations
  602.                     Number of generations to keep of specified files. 
  603.  
  604.            0compression 
  605.                     Permitted values are: 
  606.  
  607.                     COMPRESSION         Compress the specified files. 
  608.                     NOCOMPRESSION       Do not compress the specified files. 
  609.                     DEFAULT             Use the default compression for the 
  610.                                         specified files. 
  611.  
  612.  "rulebookName" 
  613.            Name of the rulebook to which the rule is to be added. 
  614.  
  615.  position 
  616.            This specifies the position where the rule is to be added to the 
  617.            file filter; 1 means add at the beginning, 2 after the first rule 
  618.            and so on. 
  619.  
  620.  
  621. ΓòÉΓòÉΓòÉ <hidden> PsnsAddRulebookRule - Returns ΓòÉΓòÉΓòÉ
  622.  
  623.       PSNS_OK 
  624.       PSNS_HANDLE_IN_USE 
  625.       PSNS_COMMUNICATIONS_ERROR 
  626.       PSNS_INVALID_HANDLE 
  627.       PSNS_INVALID_RULEBOOK 
  628.       PSNS_INVALID_DRIVE 
  629.       PSNS_INVALID_PATH 
  630.       PSNS_INVALID_FILENAME 
  631.       PSNS_INVALID_POSITION 
  632.       REXX_INVALID_HANDLE 
  633.       REXX_INVALID_PARAMETER 
  634.  
  635.  
  636. ΓòÉΓòÉΓòÉ <hidden> PsnsAddRulebookRule - Remarks ΓòÉΓòÉΓòÉ
  637.  
  638. Use this function to add a new rule to a rulebook. The rules are applied in 
  639. order, from first to last, to decide whether compression will be used and how 
  640. many generations to keep of individual files. You can add the new rule in any 
  641. position before the 'last' rule. See Rulebooks for more information about the 
  642. 'last' rule. 
  643.  
  644. stemname and rulebookName are in quotes to ensure that their cases are correct. 
  645.  
  646.  
  647. ΓòÉΓòÉΓòÉ <hidden> PsnsAddRulebookRule - Related functions ΓòÉΓòÉΓòÉ
  648.  
  649.      PsnsDeleteRulebookRule 
  650.  
  651.      PsnsListRulebookRule 
  652.  
  653.      PsnsRulebookRuleInfo 
  654.  
  655.  
  656. ΓòÉΓòÉΓòÉ 4.6. PsnsAssociateVolume ΓòÉΓòÉΓòÉ
  657.  
  658. Select an item 
  659.  
  660.      Syntax 
  661.      Parameters 
  662.      Returns 
  663.      Remarks 
  664.      Example 
  665.      Related functions 
  666.  
  667.  
  668. ΓòÉΓòÉΓòÉ <hidden> PsnsAssociateVolume - Syntax ΓòÉΓòÉΓòÉ
  669.  
  670. /***************************************************/
  671. /* This function associates an existing volume with*/
  672. /* a backup set.                                   */
  673. /***************************************************/
  674.  
  675. Call PsnsAssociateVolume handle, volumeID, "backupSet"
  676.  
  677.  
  678. ΓòÉΓòÉΓòÉ <hidden> PsnsAssociateVolume - Parameters ΓòÉΓòÉΓòÉ
  679.  
  680.  handle 
  681.            Handle returned by PsnsInit 
  682.  
  683.  volumeID 
  684.            Volume ID of the volume to be activated or deactivated. 
  685.  
  686.  "backupSet" 
  687.            The name of the backup set with which to associate the volume. 
  688.  
  689.  
  690. ΓòÉΓòÉΓòÉ <hidden> PsnsAssociateVolume - Returns ΓòÉΓòÉΓòÉ
  691.  
  692.       PSNS_OK 
  693.       PSNS_HANDLE_IN_USE 
  694.       PSNS_COMMUNICATIONS_ERROR 
  695.       PSNS_INVALID_HANDLE 
  696.       PSNS_INVALID_VOLUME 
  697.       PSNS_INVALID_BACKUP_SET 
  698.       PSNS_ALREADY_ASSOCIATED 
  699.       PSNS_INAPPROPRIATE_BACKUP_SET 
  700.       PSNS_IN_USE 
  701.       REXX_INVALID_HANDLE 
  702.  
  703.  
  704. ΓòÉΓòÉΓòÉ <hidden> PsnsAssociateVolume - Remarks ΓòÉΓòÉΓòÉ
  705.  
  706. Use this function to associate a volume with a backup set. This means that when 
  707. you perform a backup to the backup set, OS/2 Warp Server Backup/Restore will 
  708. consider the volume when it is looking for a volume with free space to store 
  709. backed-up data. This can be useful, for example, when scheduling an overnight 
  710. backup to tape: you can create a new volume in advance and associate it with 
  711. the backup set; then OS/2 Warp Server Backup/Restore can automatically use the 
  712. new volume when it comes to do the backup, rather than prompting for a new 
  713. volume. 
  714.  
  715. backupSet is in quotes to ensure that its case is correct. 
  716.  
  717.  
  718. ΓòÉΓòÉΓòÉ <hidden> PsnsAssociateVolume - Related functions ΓòÉΓòÉΓòÉ
  719.  
  720.      PsnsActivateVolume 
  721.  
  722.      PsnsCreateVolume 
  723.  
  724.      PsnsDeleteVolume 
  725.  
  726.      PsnsListVolumeBackupSets 
  727.  
  728.      PsnsListVolumes 
  729.  
  730.      PsnsVolumeInfo 
  731.  
  732.  
  733. ΓòÉΓòÉΓòÉ 4.7. PsnsBackupFiles ΓòÉΓòÉΓòÉ
  734.  
  735. Select an item 
  736.  
  737.      Syntax 
  738.      Parameters 
  739.      Returns 
  740.      Remarks 
  741.      Example 
  742.      Related functions 
  743.  
  744.  
  745. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupFiles - Syntax ΓòÉΓòÉΓòÉ
  746.  
  747. /***************************************************/
  748. /* This function backs up the list of files created*/
  749. /* by calls to PsnsAddFile                         */
  750. /***************************************************/
  751.  
  752. Call PsnsBackupFiles handle, "stemname"
  753.  
  754.  
  755. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupFiles - Parameters ΓòÉΓòÉΓòÉ
  756.  
  757.  handle 
  758.            Handle returned by PsnsInit 
  759.  
  760.  "stemname" 
  761.            The name of the stem in which the information to be used is to be 
  762.            put. 
  763.  
  764.            Stemname parameters which may be used are: 
  765.  
  766.                                0compression
  767.                     Permitted values are: 
  768.  
  769.                     COMPRESSION         Compress the specified files. 
  770.                     NOCOMPRESSION       Do not compress the specified files. 
  771.                     DEFAULT             Use the default compression for the 
  772.                                         specified files. 
  773.  
  774.                                0generations
  775.                     Number of generations to keep of specified files. 
  776.  
  777.                                0changedFilesOnly
  778.                     Permitted values are: 
  779.  
  780.                     1      Only back up files which have changed since the last 
  781.                            backup to this backup set. 
  782.                     0      Back up all files, regardless of whether they have 
  783.                            changed. 
  784.  
  785.                                0backupSet
  786.                     The name of the backup set to which the files are to be 
  787.                     backed up. If this is left blank, then the default backup 
  788.                     set will be used. 
  789.  
  790.  
  791. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupFiles - Returns ΓòÉΓòÉΓòÉ
  792.  
  793.       PSNS_OK 
  794.       PSNS_HANDLE_IN_USE 
  795.       PSNS_COMMUNICATIONS_ERROR 
  796.       PSNS_INVALID_HANDLE 
  797.       PSNS_INVALID_BACKUP_SET 
  798.       PSNS_INVALID_GENERATIONS 
  799.       PSNS_INVALID_COMPRESSION 
  800.       PSNS_TRANSFERRED_OUT 
  801.       PSNS_IN_USE 
  802.       REXX_INVALID_HANDLE 
  803.       REXX_INVALID_PARAMETER 
  804.  
  805.  
  806. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupFiles - Remarks ΓòÉΓòÉΓòÉ
  807.  
  808. Use this function to backup a list of files. 
  809.  
  810. stemname is in quotes to ensure that its case is correct. 
  811.  
  812.  
  813. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupFiles - Related functions ΓòÉΓòÉΓòÉ
  814.  
  815.      PsnsAddFile 
  816.  
  817.      PsnsDropFiles 
  818.  
  819.      PsnsListFiles 
  820.  
  821.      PsnsPurgeFiles 
  822.  
  823.      PsnsRestoreFiles 
  824.  
  825.  
  826. ΓòÉΓòÉΓòÉ 4.8. PsnsBackupMethodInfo ΓòÉΓòÉΓòÉ
  827.  
  828. Select an item 
  829.  
  830.      Syntax 
  831.      Parameters 
  832.      Returns 
  833.      Remarks 
  834.      Example 
  835.      Related functions 
  836.  
  837.  
  838. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupMethodInfo - Syntax ΓòÉΓòÉΓòÉ
  839.  
  840. /***************************************************/
  841. /* This function gets or sets all the information  */
  842. /* about a backup method                           */
  843. /***************************************************/
  844.  
  845. Call PsnsBackupMethodInfo handle, "stemname"
  846.  
  847.  
  848. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupMethodInfo - Parameters ΓòÉΓòÉΓòÉ
  849.  
  850.  handle 
  851.            Handle returned by PsnsInit 
  852.  
  853.  "stemname" 
  854.            The name of the stem from which information is to be taken and/or 
  855.            put into. 
  856.  
  857.            Stemname parameters which may have their values changed or filled in 
  858.            by the API are: 
  859.  
  860.                                0name
  861.                     The name of the backup method; this is always required. 
  862.  
  863.                                0description
  864.                     The description of the backup method. 
  865.  
  866.                                0allFiles
  867.                     Permitted values are: 
  868.  
  869.                     1        Allow backup of any file; the drive, directory and 
  870.                              subdirectories fields are ignored. 
  871.                     0        Allow backup of files specified by the drive, 
  872.                              directory and subdirectories fields. 
  873.  
  874.                                0drive
  875.                     Drive letter to back up files from; an asterisk (*) means 
  876.                     all drives. 
  877.  
  878.                                0directory
  879.                     Directory to back up files from. This may end in an 
  880.                     asterisk (*) to allow matching of more than one directory. 
  881.  
  882.                                0subdirectories
  883.                     Permitted values are: 
  884.  
  885.                     1        Include subdirectories of the specified directory. 
  886.                     0        Do not include subdirectories. 
  887.  
  888.                                0compression
  889.                     Permitted values are: 
  890.  
  891.                     COMPRESSION         Compress data. 
  892.                     NOCOMPRESSION       Don't compress data. 
  893.                     DEFAULT             Use default compression. 
  894.  
  895.                                0generations
  896.                     Number of generations of files to keep backed up. 
  897.  
  898.                                0useRulebook
  899.                     Permitted values are: 
  900.  
  901.                     1        Use the rulebook named in rulebook. The 
  902.                              compression and generations fields are ignored. 
  903.                     0        Do not use a rulebook; use the settings in 
  904.                              compression and generations. The rulebook field is 
  905.                              ignored. 
  906.  
  907.                                0rulebook
  908.                     Name of the rulebook to use. If this is blank, then the 
  909.                     default rulebook is used. 
  910.  
  911.                                0useFileFilter
  912.                     Permitted values are: 
  913.  
  914.                     1        Use the file filter named in fileFilter to decide 
  915.                              which files to back up. 
  916.                     0        Back up all the files in the selected directory. 
  917.                              fileFilteris ignored. 
  918.  
  919.                                0fileFilter
  920.                     Name of the file filter to use. If this is blank, then the 
  921.                     default file filter is used. 
  922.  
  923.                                0changedFilesOnly
  924.                     Permitted values are: 
  925.  
  926.                     1        Only back up files which have changed since the 
  927.                              last backup to this backup set. 
  928.                     0        Back up all files, regardless of whether they have 
  929.                              changed. 
  930.  
  931.                                0preview
  932.                     Permitted values are: 
  933.  
  934.                     1        Show a preview before the backup and allow the 
  935.                              user to select or deselect individual files. 
  936.                     0        Do not show a preview. 
  937.  
  938.                     Note:  Showing a preview is only useful if the backup 
  939.                     method is to be run from the OS/2 Warp Server 
  940.                     Backup/Restore window; it is not possible to show a preview 
  941.                     when running a backup method using the API. 
  942.  
  943.                                0backupSet
  944.                     Backup set to which to back up data. If this is left blank, 
  945.                     then the default backup set will be used. 
  946.  
  947.  
  948. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupMethodInfo - Returns ΓòÉΓòÉΓòÉ
  949.  
  950.       PSNS_OK 
  951.       PSNS_HANDLE_IN_USE 
  952.       PSNS_COMMUNICATIONS_ERROR 
  953.       PSNS_INVALID_HANDLE 
  954.       PSNS_INVALID_BACKUP_SET 
  955.       PSNS_INVALID_DRIVE 
  956.       PSNS_INVALID_PATH 
  957.       PSNS_INVALID_MASK 
  958.       PSNS_INVALID_COMPRESSION 
  959.       PSNS_INVALID_GENERATIONS 
  960.       PSNS_INVALID_RULEBOOK 
  961.       PSNS_INVALID_FILE_FILTER 
  962.       PSNS_INVALID_BACKUP_SET 
  963.       REXX_INVALID_HANDLE 
  964.       REXX_INVALID_MASK_NAME 
  965.  
  966.  
  967. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupMethodInfo - Remarks ΓòÉΓòÉΓòÉ
  968.  
  969. Use this function to change a backup method or to inspect the current settings 
  970. for a backup method. In order to look at the settings without changing any, do 
  971. not create any compound variables except that of the backup method name, the 
  972. API then fills in all the compound variables, so as to show the current 
  973. settings. 
  974.  
  975. Putting in a parameter means that it will be changed, from its old value. This, 
  976. however is not true for the name field. It is not possible to change the name 
  977. of a backup method with this call; to do that, use PsnsRenameBackupMethod 
  978.  
  979. stemname is in quotes to ensure that its case is correct. 
  980.  
  981.  
  982. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupMethodInfo - Related functions ΓòÉΓòÉΓòÉ
  983.  
  984.      PsnsCopyBackupMethod 
  985.  
  986.      PsnsCreateBackupMethod 
  987.  
  988.      PsnsDeleteBackupMethod 
  989.  
  990.      PsnsEstimateBackupMethod 
  991.  
  992.      PsnsListBackupMethods 
  993.  
  994.      PsnsRenameBackupMethod 
  995.  
  996.      PsnsRunBackupMethod 
  997.  
  998.  
  999. ΓòÉΓòÉΓòÉ 4.9. PsnsBackupSetInfo ΓòÉΓòÉΓòÉ
  1000.  
  1001. Select an item 
  1002.  
  1003.      Syntax 
  1004.      Parameters 
  1005.      Returns 
  1006.      Remarks 
  1007.      Example 
  1008.      Related functions 
  1009.  
  1010.  
  1011. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupSetInfo - Syntax ΓòÉΓòÉΓòÉ
  1012.  
  1013. /***************************************************/
  1014. /* This function gets or sets all the information  */
  1015. /* about a backup set                              */
  1016. /***************************************************/
  1017.  
  1018. Call PsnsBackupSetInfo handle, "stemname"
  1019.  
  1020.  
  1021. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupSetInfo - Parameters ΓòÉΓòÉΓòÉ
  1022.  
  1023.  handle 
  1024.            Handle returned by PsnsInit 
  1025.  
  1026.  "stemname" 
  1027.            The name of the stem from which information is to be taken and/or 
  1028.            put into. 
  1029.  
  1030.            Stemname parameters which may have their values changed or filled in 
  1031.            by the API are: 
  1032.  
  1033.                                0name
  1034.                     The name of the backup set; this is always required. 
  1035.  
  1036.                                0description
  1037.                     Description of the backup set. 
  1038.  
  1039.  
  1040. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupSetInfo - Returns ΓòÉΓòÉΓòÉ
  1041.  
  1042.       PSNS_OK 
  1043.       PSNS_HANDLE_IN_USE 
  1044.       PSNS_COMMUNICATIONS_ERROR 
  1045.       PSNS_INVALID_HANDLE 
  1046.       PSNS_INVALID_BACKUP_SET 
  1047.       PSNS_INVALID_MASK 
  1048.       REXX_INVALID_HANDLE 
  1049.  
  1050.  
  1051. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupSetInfo - Remarks ΓòÉΓòÉΓòÉ
  1052.  
  1053. Use this function to change a backup set or to inspect the current settings for 
  1054. a backup set. In order to look at the settings without changing any, do not 
  1055. create any compound variables except that of the backup set name, the API then 
  1056. fills in all the compound variables, so as to show the current settings. 
  1057.  
  1058. Putting in a parameter means that it will be changed, from its old value. This, 
  1059. however is not true for the name field. 
  1060.  
  1061. It is not possible to change the configuration string for a backup set with 
  1062. this call; to do that, use PsnsSetBackupSetConfig. To look at the information 
  1063. for all the backup sets, use the command PsnsListBackupSets. It is not possible 
  1064. to change which storage device a backup set uses; to do that, you must delete 
  1065. the backup set and create a new one. 
  1066.  
  1067. The stemname is in quotes to ensure that its case is correct. 
  1068.  
  1069.  
  1070. ΓòÉΓòÉΓòÉ <hidden> PsnsBackupSetInfo - Related functions ΓòÉΓòÉΓòÉ
  1071.  
  1072.      PsnsCreateBackupSet 
  1073.  
  1074.      PsnsDeleteBackupSet 
  1075.  
  1076.      PsnsEmptyBackupSet 
  1077.  
  1078.      PsnsGetBackupSetConfig 
  1079.  
  1080.      PsnsGetLogFile 
  1081.  
  1082.      PsnsListBackupSets 
  1083.  
  1084.      PsnsSetBackupSetConfig 
  1085.  
  1086.      PsnsTransferBackupSet 
  1087.  
  1088.      PsnsTransferIn 
  1089.  
  1090.  
  1091. ΓòÉΓòÉΓòÉ 4.10. PsnsCopyBackupMethod ΓòÉΓòÉΓòÉ
  1092.  
  1093. Select an item 
  1094.  
  1095.      Syntax 
  1096.      Parameters 
  1097.      Returns 
  1098.      Remarks 
  1099.      Example 
  1100.      Related functions 
  1101.  
  1102.  
  1103. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  1104.  
  1105. /***************************************************/
  1106. /* This function creates a new backup method which */
  1107. /* is a copy of an existing backup method          */
  1108. /***************************************************/
  1109.  
  1110. Call PsnsCopyBackupMethod handle, "name", "newName"
  1111.  
  1112.  
  1113. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  1114.  
  1115.  handle 
  1116.            Handle returned by PsnsInit 
  1117.  
  1118.  "name" 
  1119.            The name of the existing backup method which you wish to copy. 
  1120.  
  1121.  "newName" 
  1122.            The name of the new backup method. 
  1123.  
  1124.  
  1125. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyBackupMethod - Returns ΓòÉΓòÉΓòÉ
  1126.  
  1127.       PSNS_OK 
  1128.       PSNS_HANDLE_IN_USE 
  1129.       PSNS_COMMUNICATIONS_ERROR 
  1130.       PSNS_INVALID_HANDLE 
  1131.       PSNS_INVALID_BACKUP_METHOD 
  1132.       PSNS_ALREADY_EXISTS 
  1133.       PSNS_INVALID_NAME 
  1134.       REXX_INVALID_HANDLE 
  1135.  
  1136.  
  1137. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  1138.  
  1139. Use this function to create a new backup method which is a copy of an existing 
  1140. one. newName must not be the same as the name of any existing backup method. 
  1141.  
  1142. name and newName are in quotes to ensure that their cases are correct. 
  1143.  
  1144.  
  1145. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  1146.  
  1147.      PsnsBackupMethodInfo 
  1148.  
  1149.      PsnsCreateBackupMethod 
  1150.  
  1151.      PsnsDeleteBackupMethod 
  1152.  
  1153.      PsnsEstimateBackupMethod 
  1154.  
  1155.      PsnsListBackupMethods 
  1156.  
  1157.      PsnsRenameBackupMethod 
  1158.  
  1159.      PsnsRunBackupMethod 
  1160.  
  1161.  
  1162. ΓòÉΓòÉΓòÉ 4.11. PsnsCopyEvent ΓòÉΓòÉΓòÉ
  1163.  
  1164. Select an item 
  1165.  
  1166.      Syntax 
  1167.      Parameters 
  1168.      Returns 
  1169.      Remarks 
  1170.      Example 
  1171.      Related functions 
  1172.  
  1173.  
  1174. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyEvent - Syntax ΓòÉΓòÉΓòÉ
  1175.  
  1176. /***************************************************/
  1177. /* This function creates a new event which is a    */
  1178. /* copy of an existing event.                      */
  1179. /***************************************************/
  1180.  
  1181. Call PsnsCopyEvent handle, eventID
  1182.  
  1183.  
  1184. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyEvent - Parameters ΓòÉΓòÉΓòÉ
  1185.  
  1186.  handle 
  1187.            Handle returned by PsnsInit 
  1188.  
  1189.  eventID 
  1190.            The ID of the existing event which you wish to copy. 
  1191.  
  1192.  
  1193. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyEvent - Returns ΓòÉΓòÉΓòÉ
  1194.  
  1195.       PSNS_OK 
  1196.       PSNS_HANDLE_IN_USE 
  1197.       PSNS_COMMUNICATIONS_ERROR 
  1198.       PSNS_INVALID_HANDLE 
  1199.       PSNS_INVALID_EVENT 
  1200.       REXX_INVALID_HANDLE 
  1201.  
  1202.  
  1203. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyEvent - Remarks ΓòÉΓòÉΓòÉ
  1204.  
  1205. Use this function to create a new event which is a copy of an existing one. The 
  1206. ID of the newly-created event is returned in the REXX variable newEventID 
  1207.  
  1208.  
  1209. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyEvent - Related functions ΓòÉΓòÉΓòÉ
  1210.  
  1211.      PsnsActivateEvent 
  1212.  
  1213.      PsnsCreateEvent 
  1214.  
  1215.      PsnsDeleteEvent 
  1216.  
  1217.      PsnsEventInfo 
  1218.  
  1219.      PsnsGetNextEvent 
  1220.  
  1221.      PsnsListEvents 
  1222.  
  1223.  
  1224. ΓòÉΓòÉΓòÉ 4.12. PsnsCopyFileFilter ΓòÉΓòÉΓòÉ
  1225.  
  1226. Select an item 
  1227.  
  1228.      Syntax 
  1229.      Parameters 
  1230.      Returns 
  1231.      Remarks 
  1232.      Example 
  1233.      Related functions 
  1234.  
  1235.  
  1236. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyFileFilter - Syntax ΓòÉΓòÉΓòÉ
  1237.  
  1238. /***************************************************/
  1239. /* This function creates a new file filter which   */
  1240. /* is a copy of an existing file filter            */
  1241. /***************************************************/
  1242.  
  1243. Call PsnsCopyFileFilter handle, "name", "newName"
  1244.  
  1245.  
  1246. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyFileFilter - Parameters ΓòÉΓòÉΓòÉ
  1247.  
  1248.  handle 
  1249.            Handle returned by PsnsInit 
  1250.  
  1251.  "name" 
  1252.            The name of the existing file filter which you wish to copy. 
  1253.  
  1254.  "newName" 
  1255.            The name of the new file filter. 
  1256.  
  1257.  
  1258. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyFileFilter - Returns ΓòÉΓòÉΓòÉ
  1259.  
  1260.       PSNS_OK 
  1261.       PSNS_HANDLE_IN_USE 
  1262.       PSNS_COMMUNICATIONS_ERROR 
  1263.       PSNS_INVALID_HANDLE 
  1264.       PSNS_INVALID_FILE_FILTER 
  1265.       PSNS_ALREADY_EXISTS 
  1266.       PSNS_INVALID_NAME 
  1267.       REXX_INVALID_HANDLE 
  1268.  
  1269.  
  1270. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyFileFilter - Remarks ΓòÉΓòÉΓòÉ
  1271.  
  1272. Use this function to create a new file filter which is a copy of an existing 
  1273. one. newName must not be the same as the name of any existing file filter. 
  1274.  
  1275. name and newName are in quotes to ensure that their cases are correct. 
  1276.  
  1277.  
  1278. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyFileFilter - Related functions ΓòÉΓòÉΓòÉ
  1279.  
  1280.      PsnsCreateFileFilter 
  1281.  
  1282.      PsnsDeleteFileFilter 
  1283.  
  1284.      PsnsFileFilterInfo 
  1285.  
  1286.      PsnsListFileFilters 
  1287.  
  1288.      PsnsRenameFileFilter 
  1289.  
  1290.  
  1291. ΓòÉΓòÉΓòÉ 4.13. PsnsCopyRestoreMethod ΓòÉΓòÉΓòÉ
  1292.  
  1293. Select an item 
  1294.  
  1295.      Syntax 
  1296.      Parameters 
  1297.      Returns 
  1298.      Remarks 
  1299.      Example 
  1300.      Related functions 
  1301.  
  1302.  
  1303. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  1304.  
  1305. /****************************************************/
  1306. /* This function creates a new restore method which */
  1307. /* is a copy of an existing restore method          */
  1308. /****************************************************/
  1309.  
  1310. Call PsnsCopyRestoreMethod handle, "name", "newName"
  1311.  
  1312.  
  1313. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  1314.  
  1315.  handle 
  1316.            Handle returned by PsnsInit 
  1317.  
  1318.  "name" 
  1319.            The name of the existing restore method which you wish to copy. 
  1320.  
  1321.  "newName" 
  1322.            The name of the new restore method. 
  1323.  
  1324.  
  1325. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  1326.  
  1327.       PSNS_OK 
  1328.       PSNS_HANDLE_IN_USE 
  1329.       PSNS_COMMUNICATIONS_ERROR 
  1330.       PSNS_INVALID_HANDLE 
  1331.       PSNS_INVALID_RESTORE_METHOD 
  1332.       PSNS_ALREADY_EXISTS 
  1333.       PSNS_INVALID_NAME 
  1334.       REXX_INVALID_HANDLE 
  1335.  
  1336.  
  1337. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  1338.  
  1339. Use this function to create a new restore method which is a copy of an existing 
  1340. one. newName must not be the same as the name of any existing restore method. 
  1341.  
  1342. name and newName are in quotes to ensure that their cases are correct. 
  1343.  
  1344.  
  1345. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  1346.  
  1347.      PsnsCreateRestoreMethod 
  1348.  
  1349.      PsnsDeleteRestoreMethod 
  1350.  
  1351.      PsnsEstimateRestoreMethod 
  1352.  
  1353.      PsnsListRestoreMethods 
  1354.  
  1355.      PsnsRenameRestoreMethod 
  1356.  
  1357.      PsnsRestoreMethodInfo 
  1358.  
  1359.      PsnsRunRestoreMethod 
  1360.  
  1361.  
  1362. ΓòÉΓòÉΓòÉ 4.14. PsnsCopyRulebook ΓòÉΓòÉΓòÉ
  1363.  
  1364. Select an item 
  1365.  
  1366.      Syntax 
  1367.      Parameters 
  1368.      Returns 
  1369.      Remarks 
  1370.      Example 
  1371.      Related functions 
  1372.  
  1373.  
  1374. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRulebook - Syntax ΓòÉΓòÉΓòÉ
  1375.  
  1376. /***************************************************/
  1377. /* This function creates a new rulebook which      */
  1378. /* is a copy of an existing rulebook               */
  1379. /***************************************************/
  1380.  
  1381. Call PsnsCopyRulebook handle, "name", "newName"
  1382.  
  1383.  
  1384. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRulebook - Parameters ΓòÉΓòÉΓòÉ
  1385.  
  1386.  handle 
  1387.            Handle returned by PsnsInit 
  1388.  
  1389.  "name" 
  1390.            The name of the existing rulebook which you wish to copy. 
  1391.  
  1392.  "newName" 
  1393.            The name of the new rulebook. 
  1394.  
  1395.  
  1396. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRulebook - Returns ΓòÉΓòÉΓòÉ
  1397.  
  1398.       PSNS_OK 
  1399.       PSNS_HANDLE_IN_USE 
  1400.       PSNS_COMMUNICATIONS_ERROR 
  1401.       PSNS_INVALID_HANDLE 
  1402.       PSNS_INVALID_RULEBOOK 
  1403.       PSNS_ALREADY_EXISTS 
  1404.       PSNS_INVALID_NAME 
  1405.       REXX_INVALID_HANDLE 
  1406.  
  1407.  
  1408. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRulebook - Remarks ΓòÉΓòÉΓòÉ
  1409.  
  1410. Use this function to create a new rulebook which is a copy of an existing one. 
  1411. newName must not be the same as the name of any existing rulebook. 
  1412.  
  1413. name and newName are in quotes to ensure that their cases are correct. 
  1414.  
  1415.  
  1416. ΓòÉΓòÉΓòÉ <hidden> PsnsCopyRulebook - Related functions ΓòÉΓòÉΓòÉ
  1417.  
  1418.      PsnsCreateRulebook 
  1419.  
  1420.      PsnsDeleteRulebook 
  1421.  
  1422.      PsnsListRulebooks 
  1423.  
  1424.      PsnsRenameRulebook 
  1425.  
  1426.      PsnsRulebookInfo 
  1427.  
  1428.  
  1429. ΓòÉΓòÉΓòÉ 4.15. PsnsCreateBackupMethod ΓòÉΓòÉΓòÉ
  1430.  
  1431. Select an item 
  1432.  
  1433.      Syntax 
  1434.      Parameters 
  1435.      Returns 
  1436.      Remarks 
  1437.      Example 
  1438.      Related functions 
  1439.  
  1440.  
  1441. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  1442.  
  1443. /***************************************************/
  1444. /* This function creates a new backup method       */
  1445. /***************************************************/
  1446.  
  1447. Call PsnsCreateBackupMethod handle, "name"
  1448.  
  1449.  
  1450. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  1451.  
  1452.  handle 
  1453.            Handle returned by PsnsInit 
  1454.  
  1455.  "name" 
  1456.            The name of the method to be created. 
  1457.  
  1458.  
  1459. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupMethod - Returns ΓòÉΓòÉΓòÉ
  1460.  
  1461.       PSNS_OK 
  1462.       PSNS_HANDLE_IN_USE 
  1463.       PSNS_COMMUNICATIONS_ERROR 
  1464.       PSNS_INVALID_HANDLE 
  1465.       PSNS_ALREADY_EXISTS 
  1466.       PSNS_INVALID_NAME 
  1467.       REXX_INVALID_HANDLE 
  1468.  
  1469.  
  1470. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  1471.  
  1472. Use this function to create a new backup method. name must not be the name of 
  1473. any existing backup method. The backup method is created with default settings; 
  1474. you can use PsnsBackupMethodInfo to change these. 
  1475.  
  1476. name is in quotes to ensure that its case is correct. 
  1477.  
  1478.  
  1479. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  1480.  
  1481.      PsnsBackupMethodInfo 
  1482.  
  1483.      PsnsCopyBackupMethod 
  1484.  
  1485.      PsnsDeleteBackupMethod 
  1486.  
  1487.      PsnsEstimateBackupMethod 
  1488.  
  1489.      PsnsListBackupMethods 
  1490.  
  1491.      PsnsRenameBackupMethod 
  1492.  
  1493.      PsnsRunBackupMethod 
  1494.  
  1495.  
  1496. ΓòÉΓòÉΓòÉ 4.16. PsnsCreateBackupSet ΓòÉΓòÉΓòÉ
  1497.  
  1498. Select an item 
  1499.  
  1500.      Syntax 
  1501.      Parameters 
  1502.      Returns 
  1503.      Remarks 
  1504.      Example 
  1505.      Related functions 
  1506.  
  1507.  
  1508. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupSet - Syntax ΓòÉΓòÉΓòÉ
  1509.  
  1510. /***************************************************/
  1511. /* This function creates a new backup set          */
  1512. /***************************************************/
  1513.  
  1514. Call PsnsCreateBackupSet handle, "setName",
  1515.                         "storageDevice", "config",
  1516.                         "incStorageDevice", "incConfig"
  1517.  
  1518.  
  1519. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupSet - Parameters ΓòÉΓòÉΓòÉ
  1520.  
  1521.  handle 
  1522.            Handle returned by PsnsInit 
  1523.  
  1524.  "setName" 
  1525.            The name of the backup set to be created. 
  1526.  
  1527.  "storageDevice" 
  1528.            For a single device backup set, this is the storage device which the 
  1529.            backup set will use for all backups, incStorageDevice and incConfig 
  1530.            should not be set, that is PsnsCreateBackupSet should only be called 
  1531.            with four arguments. For a dual device backup set this is the name 
  1532.            of the storage device which this backup set will use for the base 
  1533.            backup, you should also specify an incremental storage device. 
  1534.  
  1535.  "config" 
  1536.            Configuration string for the device; for more information see 
  1537.            PsnsSetBackupSetConfig. For dual device backup sets this is the 
  1538.            configuration string for the base storage device. 
  1539.  
  1540.  "incStorageDevice" 
  1541.            Name of the storage device which this dual device backup set will 
  1542.            use for incremental backups. When creating single device backup 
  1543.            sets, this argument is omitted. 
  1544.  
  1545.  "incConfig" 
  1546.            Configuration string for the incremental drive; for more information 
  1547.            see PsnsSetBackupSetConfig. When creating single device backup sets, 
  1548.            this argument is omitted. 
  1549.  
  1550.  
  1551. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupSet - Returns ΓòÉΓòÉΓòÉ
  1552.  
  1553.       PSNS_OK 
  1554.       PSNS_HANDLE_IN_USE 
  1555.       PSNS_COMMUNICATIONS_ERROR 
  1556.       PSNS_INVALID_HANDLE 
  1557.       PSNS_ALREADY_EXISTS 
  1558.       PSNS_INVALID_NAME 
  1559.       PSNS_INVALID_STORAGE_DEVICE 
  1560.       PSNS_CANNOT_CREATE_BACKUP_SET 
  1561.       PSNS_INVALID_KEYWORD 
  1562.       PSNS_INVALID_VALUE 
  1563.       PSNS_SYNTAX_ERROR 
  1564.       PSNS_INCOMPLETE_STRING 
  1565.       PSNS_SEMANTIC_ERROR 
  1566.       REXX_INVALID_HANDLE 
  1567.  
  1568.  
  1569. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupSet - Remarks ΓòÉΓòÉΓòÉ
  1570.  
  1571. Use this function to create a new backup set. name must not be the name of any 
  1572. existing backup set. The event is created with default settings; you can use 
  1573. PsnsBackupSetInfo to change these. When creating a normal, single storage 
  1574. device backup set the last two parameters should be omitted. When creating a 
  1575. dual storage device backup set specify all the parameters. 
  1576.  
  1577. setName, storageDevice, config, incStorageDevice, and incConfig are in quotes 
  1578. to ensure that their cases are correct. 
  1579.  
  1580.  
  1581. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateBackupSet - Related functions ΓòÉΓòÉΓòÉ
  1582.  
  1583.      PsnsBackupSetInfo 
  1584.  
  1585.      PsnsDeleteBackupSet 
  1586.  
  1587.      PsnsEmptyBackupSet 
  1588.  
  1589.      PsnsGetBackupSetConfig 
  1590.  
  1591.      PsnsGetLogFile 
  1592.  
  1593.      PsnsListBackupSets 
  1594.  
  1595.      PsnsSetBackupSetConfig 
  1596.  
  1597.      PsnsTransferBackupSet 
  1598.  
  1599.      PsnsTransferIn 
  1600.  
  1601.  
  1602. ΓòÉΓòÉΓòÉ 4.17. PsnsCreateEvent ΓòÉΓòÉΓòÉ
  1603.  
  1604. Select an item 
  1605.  
  1606.      Syntax 
  1607.      Parameters 
  1608.      Returns 
  1609.      Remarks 
  1610.      Example 
  1611.      Related functions 
  1612.  
  1613.  
  1614. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateEvent - Syntax ΓòÉΓòÉΓòÉ
  1615.  
  1616. /***************************************************/
  1617. /* This function creates a new scheduled event     */
  1618. /***************************************************/
  1619.  
  1620. Call PsnsCreateEvent handle, "eventInfoMask", "method"
  1621.  
  1622.  
  1623. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateEvent - Parameters ΓòÉΓòÉΓòÉ
  1624.  
  1625.  handle 
  1626.            Handle returned by PsnsInit 
  1627.  
  1628.  "eventInfoMask" 
  1629.            The type of event to be created. Possible types are: 
  1630.  
  1631.            REGULAR             A regular interval event. 
  1632.            DAILY               A daily event. 
  1633.            STARTUP             A startup event. 
  1634.            NAMEDDAYS           A named day event. 
  1635.            MONTHLY             A monthly event. 
  1636.  
  1637.  "method" 
  1638.            Name of the backup method which the event will use. This can be 
  1639.            changed later, but must be specified when you first create an event. 
  1640.  
  1641.  
  1642. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateEvent - Returns ΓòÉΓòÉΓòÉ
  1643.  
  1644.       PSNS_OK 
  1645.       PSNS_HANDLE_IN_USE 
  1646.       PSNS_COMMUNICATIONS_ERROR 
  1647.       PSNS_INVALID_HANDLE 
  1648.       PSNS_INVALID_EVENT_TYPE 
  1649.       REXX_INVALID_HANDLE 
  1650.       REXX_INVALID_MASK_NAME 
  1651.  
  1652.  
  1653. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateEvent - Remarks ΓòÉΓòÉΓòÉ
  1654.  
  1655. Use this function to create a new scheduled event. The ID of the event is 
  1656. returned in a REXX variable eventID. The event is created with default 
  1657. settings; you can use PsnsEventInfo to change these. 
  1658.  
  1659. eventInfoMask and method are in quotes to ensure that their cases are correct. 
  1660.  
  1661.  
  1662. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateEvent - Related functions ΓòÉΓòÉΓòÉ
  1663.  
  1664.      PsnsActivateEvent 
  1665.  
  1666.      PsnsCopyEvent 
  1667.  
  1668.      PsnsDeleteEvent 
  1669.  
  1670.      PsnsEventInfo 
  1671.  
  1672.      PsnsGetNextEvent 
  1673.  
  1674.      PsnsListEvents 
  1675.  
  1676.  
  1677. ΓòÉΓòÉΓòÉ 4.18. PsnsCreateFileFilter ΓòÉΓòÉΓòÉ
  1678.  
  1679. Select an item 
  1680.  
  1681.      Syntax 
  1682.      Parameters 
  1683.      Returns 
  1684.      Remarks 
  1685.      Example 
  1686.      Related functions 
  1687.  
  1688.  
  1689. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateFileFilter - Syntax ΓòÉΓòÉΓòÉ
  1690.  
  1691. /***************************************************/
  1692. /* This function creates a new file filter         */
  1693. /***************************************************/
  1694.  
  1695. Call PsnsCreateFileFilter handle, "name", "type"
  1696.  
  1697.  
  1698. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateFileFilter - Parameters ΓòÉΓòÉΓòÉ
  1699.  
  1700.  handle 
  1701.            Handle returned by PsnsInit 
  1702.  
  1703.  "name" 
  1704.            The name of the file filter to be created. 
  1705.  
  1706.  "type" 
  1707.            Type of file filter to create. 
  1708.  
  1709.            TREE     Tree-based filter. 
  1710.            LIST     Rule-based filter. 
  1711.  
  1712.            Note:  All file filters are stored as rule-based filters; the type 
  1713.            only affects how the file filter is displayed when it is edited. 
  1714.  
  1715.  
  1716. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateFileFilter - Returns ΓòÉΓòÉΓòÉ
  1717.  
  1718.       PSNS_OK 
  1719.       PSNS_HANDLE_IN_USE 
  1720.       PSNS_COMMUNICATIONS_ERROR 
  1721.       PSNS_INVALID_HANDLE 
  1722.       PSNS_ALREADY_EXISTS 
  1723.       PSNS_INVALID_NAME 
  1724.       PSNS_INVALID_FILE_FILTER_TYPE 
  1725.       REXX_INVALID_HANDLE 
  1726.       REXX_INVALID_PARAMETER 
  1727.  
  1728.  
  1729. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateFileFilter - Remarks ΓòÉΓòÉΓòÉ
  1730.  
  1731. Use this function to create a new file filter. name must not be the name of any 
  1732. existing file filter. The file filter is created with one rule which cannot be 
  1733. deleted and is referred to as the 'last' rule. You can use PsnsFileFilterInfo 
  1734. to change the file filter settings and PsnsAddFileFilterRule to add new rules 
  1735. to it. 
  1736.  
  1737. name and type are in quotes to ensure that their cases are correct. 
  1738.  
  1739.  
  1740. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateFileFilter - Related functions ΓòÉΓòÉΓòÉ
  1741.  
  1742.      PsnsAddFileFilterRule 
  1743.  
  1744.      PsnsCopyFileFilter 
  1745.  
  1746.      PsnsDeleteFileFilter 
  1747.  
  1748.      PsnsFileFilterInfo 
  1749.  
  1750.      PsnsListFileFilters 
  1751.  
  1752.      PsnsRenameFileFilter 
  1753.  
  1754.  
  1755. ΓòÉΓòÉΓòÉ 4.19. PsnsCreateRestoreMethod ΓòÉΓòÉΓòÉ
  1756.  
  1757. Select an item 
  1758.  
  1759.      Syntax 
  1760.      Parameters 
  1761.      Returns 
  1762.      Remarks 
  1763.      Example 
  1764.      Related functions 
  1765.  
  1766.  
  1767. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  1768.  
  1769. /***************************************************/
  1770. /* This function creates a new restore method      */
  1771. /***************************************************/
  1772.  
  1773. Call PsnsCreateRestoreMethod handle, "name"
  1774.  
  1775.  
  1776. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  1777.  
  1778.  handle 
  1779.            Handle returned by PsnsInit 
  1780.  
  1781.  "name" 
  1782.            The name of the method to be created. 
  1783.  
  1784.  
  1785. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  1786.  
  1787.       PSNS_OK 
  1788.       PSNS_HANDLE_IN_USE 
  1789.       PSNS_COMMUNICATIONS_ERROR 
  1790.       PSNS_INVALID_HANDLE 
  1791.       PSNS_ALREADY_EXISTS 
  1792.       PSNS_INVALID_NAME 
  1793.       REXX_INVALID_HANDLE 
  1794.  
  1795.  
  1796. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  1797.  
  1798. Use this function to create a new restore method. name must not be the name of 
  1799. any existing restore method. The restore method is created with default 
  1800. settings; you can use PsnsRestoreMethodInfo to change these. 
  1801.  
  1802. name is in quotes to ensure that its case is correct. 
  1803.  
  1804.  
  1805. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  1806.  
  1807.      PsnsCopyRestoreMethod 
  1808.  
  1809.      PsnsDeleteRestoreMethod 
  1810.  
  1811.      PsnsEstimateRestoreMethod 
  1812.  
  1813.      PsnsListRestoreMethods 
  1814.  
  1815.      PsnsRenameRestoreMethod 
  1816.  
  1817.      PsnsRestoreMethodInfo 
  1818.  
  1819.      PsnsRunRestoreMethod 
  1820.  
  1821.  
  1822. ΓòÉΓòÉΓòÉ 4.20. PsnsCreateRulebook ΓòÉΓòÉΓòÉ
  1823.  
  1824. Select an item 
  1825.  
  1826.      Syntax 
  1827.      Parameters 
  1828.      Returns 
  1829.      Remarks 
  1830.      Example 
  1831.      Related functions 
  1832.  
  1833.  
  1834. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRulebook - Syntax ΓòÉΓòÉΓòÉ
  1835.  
  1836. /***************************************************/
  1837. /* This function creates a new rulebook            */
  1838. /***************************************************/
  1839.  
  1840. Call PsnsCreateRulebook handle, "name"
  1841.  
  1842.  
  1843. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRulebook - Parameters ΓòÉΓòÉΓòÉ
  1844.  
  1845.  handle 
  1846.            Handle returned by PsnsInit 
  1847.  
  1848.  "name" 
  1849.            The name of the rulebook to be created. 
  1850.  
  1851.  
  1852. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRulebook - Returns ΓòÉΓòÉΓòÉ
  1853.  
  1854.       PSNS_OK 
  1855.       PSNS_HANDLE_IN_USE 
  1856.       PSNS_COMMUNICATIONS_ERROR 
  1857.       PSNS_INVALID_HANDLE 
  1858.       PSNS_ALREADY_EXISTS 
  1859.       PSNS_INVALID_NAME 
  1860.       REXX_INVALID_HANDLE 
  1861.  
  1862.  
  1863. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRulebook - Remarks ΓòÉΓòÉΓòÉ
  1864.  
  1865. Use this function to create a new rulebook. name must not be the name of any 
  1866. existing rulebook. The rulebook is created with one rule which cannot be 
  1867. deleted and is referred to as the 'last' rule. You can use PsnsRulebookInfo to 
  1868. change the rulebook settings and PsnsAddRulebookRule to add new rules to it. 
  1869.  
  1870. name is in quotes to ensure that its case is correct. 
  1871.  
  1872.  
  1873. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateRulebook - Related functions ΓòÉΓòÉΓòÉ
  1874.  
  1875.      PsnsAddRulebookRule 
  1876.  
  1877.      PsnsCopyRulebook 
  1878.  
  1879.      PsnsDeleteRulebook 
  1880.  
  1881.      PsnsListRulebooks 
  1882.  
  1883.      PsnsRenameRulebook 
  1884.  
  1885.      PsnsRulebookInfo 
  1886.  
  1887.  
  1888. ΓòÉΓòÉΓòÉ 4.21. PsnsCreateStorageDevice ΓòÉΓòÉΓòÉ
  1889.  
  1890. Select an item 
  1891.  
  1892.      Syntax 
  1893.      Parameters 
  1894.      Returns 
  1895.      Remarks 
  1896.      Example 
  1897.      Related functions 
  1898.  
  1899.  
  1900. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateStorageDevice - Syntax ΓòÉΓòÉΓòÉ
  1901.  
  1902. /***************************************************/
  1903. /* This function creates a new storage device      */
  1904. /***************************************************/
  1905.  
  1906. Call PsnsCreateStorageDevice handle, "storageDeviceType",
  1907.                              "configurationString"
  1908.  
  1909.  
  1910. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateStorageDevice - Parameters ΓòÉΓòÉΓòÉ
  1911.  
  1912.  handle 
  1913.            Handle returned by PsnsInit 
  1914.  
  1915.  "storageDeviceType" 
  1916.            The name of the storage device type you wish to create. To find out 
  1917.            what to put here, you should use PsnsListCreatableStorageDevices; 
  1918.            this will list all the storage device types available for creating 
  1919.            new storage devices. 
  1920.  
  1921.  "configurationString" 
  1922.            Configuration string for the storage device; for more information 
  1923.            see PsnsSetStorageDeviceConfig. 
  1924.  
  1925.  
  1926. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateStorageDevice - Returns ΓòÉΓòÉΓòÉ
  1927.  
  1928.       PSNS_OK 
  1929.       PSNS_HANDLE_IN_USE 
  1930.       PSNS_COMMUNICATIONS_ERROR 
  1931.       PSNS_INVALID_HANDLE 
  1932.       PSNS_INVALID_STORAGE_DEVICE_TYPE 
  1933.       PSNS_ALREADY_EXISTS 
  1934.       PSNS_INVALID_NAME 
  1935.       PSNS_INVALID_KEYWORD 
  1936.       PSNS_INVALID_VALUE 
  1937.       PSNS_SYNTAX_ERROR 
  1938.       PSNS_INCOMPLETE_STRING 
  1939.       PSNS_SEMANTIC_ERROR 
  1940.       REXX_INVALID_HANDLE 
  1941.  
  1942.  
  1943. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateStorageDevice - Remarks ΓòÉΓòÉΓòÉ
  1944.  
  1945. Use this function to create a new storage device. The name of the device 
  1946. created is placed in the REXX variable deviceName. You will need to specify 
  1947. what type of storage device is being created. To get a list of all the 
  1948. available storage device types for creating a new storage device, you should 
  1949. call PsnsListCreatableStorageDevices. The storage device is created with the 
  1950. default settings; to change them, use PsnsSetStorageDeviceConfig. 
  1951.  
  1952. storageDeviceType and configurationString are in quotes to ensure that their 
  1953. cases are correct. 
  1954.  
  1955.  
  1956. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateStorageDevice - Related functions ΓòÉΓòÉΓòÉ
  1957.  
  1958.      PsnsDeleteStorageDevice 
  1959.  
  1960.      PsnsGetStorageDeviceConfig 
  1961.  
  1962.      PsnsListCreatableStorageDevices 
  1963.  
  1964.      PsnsListStorageDevices 
  1965.  
  1966.      PsnsRefreshStorageDevices 
  1967.  
  1968.      PsnsSetStorageDeviceConfig 
  1969.  
  1970.      PsnsStorageDeviceInfo 
  1971.  
  1972.  
  1973. ΓòÉΓòÉΓòÉ 4.22. PsnsCreateVolume ΓòÉΓòÉΓòÉ
  1974.  
  1975. Select an item 
  1976.  
  1977.      Syntax 
  1978.      Parameters 
  1979.      Returns 
  1980.      Remarks 
  1981.      Example 
  1982.      Related functions 
  1983.  
  1984.  
  1985. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateVolume - Syntax ΓòÉΓòÉΓòÉ
  1986.  
  1987. /***************************************************/
  1988. /* This function creates a new volume              */
  1989. /***************************************************/
  1990.  
  1991. Call PsnsCreateVolume handle, "storageDeviceName"
  1992.  
  1993.  
  1994. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateVolume - Parameters ΓòÉΓòÉΓòÉ
  1995.  
  1996.  handle 
  1997.            Handle returned by PsnsInit 
  1998.  
  1999.  "storageDeviceName" 
  2000.            The name of the storage device with which to create the volume. 
  2001.  
  2002.  
  2003. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateVolume - Returns ΓòÉΓòÉΓòÉ
  2004.  
  2005.       PSNS_OK 
  2006.       PSNS_HANDLE_IN_USE 
  2007.       PSNS_COMMUNICATIONS_ERROR 
  2008.       PSNS_INVALID_HANDLE 
  2009.       PSNS_INVALID_STORAGE_DEVICE 
  2010.       PSNS_INVALID_STORAGE_DEVICE_TYPE 
  2011.       PSNS_IN_USE 
  2012.       REXX_INVALID_HANDLE 
  2013.  
  2014.  
  2015. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateVolume - Remarks ΓòÉΓòÉΓòÉ
  2016.  
  2017. Use this function to create a new volume. The ID of the volume is placed in the 
  2018. REXX variable volumeID. The volume will not be associated with any backup set 
  2019. and will not be used until you have called PsnsAssociateVolume to associate it 
  2020. with a backup set. 
  2021.  
  2022. storageDeviceName is in quotes to ensure that its case is correct. 
  2023.  
  2024.  
  2025. ΓòÉΓòÉΓòÉ <hidden> PsnsCreateVolume - Related functions ΓòÉΓòÉΓòÉ
  2026.  
  2027.      PsnsActivateVolume 
  2028.  
  2029.      PsnsAssociateVolume 
  2030.  
  2031.      PsnsDeleteVolume 
  2032.  
  2033.      PsnsListVolumeBackupSets 
  2034.  
  2035.      PsnsListVolumes 
  2036.  
  2037.      PsnsVolumeInfo 
  2038.  
  2039.  
  2040. ΓòÉΓòÉΓòÉ 4.23. PsnsDefaultsInfo ΓòÉΓòÉΓòÉ
  2041.  
  2042. Select an item 
  2043.  
  2044.      Syntax 
  2045.      Parameters 
  2046.      Returns 
  2047.      Remarks 
  2048.      Example 
  2049.      Related functions 
  2050.  
  2051.  
  2052. ΓòÉΓòÉΓòÉ <hidden> PsnsDefaultsInfo - Syntax ΓòÉΓòÉΓòÉ
  2053.  
  2054. /***************************************************/
  2055. /* This function sets the default file filter,     */
  2056. /* rulebook, backup set, compression and number of */
  2057. /* generations                                     */
  2058. /***************************************************/
  2059.  
  2060. Call PsnsDefaultsInfo handle, "stemname"
  2061.  
  2062.  
  2063. ΓòÉΓòÉΓòÉ <hidden> PsnsDefaultsInfo - Parameters ΓòÉΓòÉΓòÉ
  2064.  
  2065.  handle 
  2066.            Handle returned by PsnsInit 
  2067.  
  2068.  "stemname" 
  2069.            The name of the stem in which the information to be changed is put. 
  2070.  
  2071.            Stemname parameters which may be used are: 
  2072.  
  2073.            0compression 
  2074.                     Permitted values are: 
  2075.  
  2076.                     1      Do compress data by default. 
  2077.                     0      Don't compress data by default. 
  2078.  
  2079.                                0generations
  2080.                     Default number of generations to keep backed up. 
  2081.  
  2082.                                0rulebook
  2083.                     Name of the default rulebook. 
  2084.  
  2085.                                0fileFilter
  2086.                     Name of the default file filter. 
  2087.  
  2088.                                0backupSet
  2089.                     Name of the default backup set. 
  2090.  
  2091.  
  2092. ΓòÉΓòÉΓòÉ <hidden> PsnsDefaultsInfo - Returns ΓòÉΓòÉΓòÉ
  2093.  
  2094.       PSNS_OK 
  2095.       PSNS_HANDLE_IN_USE 
  2096.       PSNS_COMMUNICATIONS_ERROR 
  2097.       PSNS_INVALID_HANDLE 
  2098.       PSNS_INVALID_COMPRESSION 
  2099.       PSNS_INVALID_GENERATIONS 
  2100.       PSNS_INVALID_RULEBOOK 
  2101.       PSNS_INVALID_FILE_FILTER 
  2102.       REXX_INVALID_HANDLE 
  2103.  
  2104.  
  2105. ΓòÉΓòÉΓòÉ <hidden> PsnsDefaultsInfo - Remarks ΓòÉΓòÉΓòÉ
  2106.  
  2107. Use this function to change the default file filter, rulebook, backup set, 
  2108. compression and number of generations to be kept. Putting in a parameter means 
  2109. that it will be changed, from its old value. To look at the current defaults 
  2110. use PsnsListDefaults. 
  2111.  
  2112. stemname is in quotes to ensure that its case is correct. 
  2113.  
  2114.  
  2115. ΓòÉΓòÉΓòÉ <hidden> PsnsDefaultsInfo - Related functions ΓòÉΓòÉΓòÉ
  2116.  
  2117.      PsnsListDefaults 
  2118.  
  2119.      PsnsListSettings 
  2120.  
  2121.      PsnsSettingsInfo 
  2122.  
  2123.  
  2124. ΓòÉΓòÉΓòÉ 4.24. PsnsDeleteBackupMethod ΓòÉΓòÉΓòÉ
  2125.  
  2126. Select an item 
  2127.  
  2128.      Syntax 
  2129.      Parameters 
  2130.      Returns 
  2131.      Remarks 
  2132.      Example 
  2133.      Related functions 
  2134.  
  2135.  
  2136. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  2137.  
  2138. /***************************************************/
  2139. /* This function deletes a backup method           */
  2140. /***************************************************/
  2141.  
  2142. Call PsnsDeleteBackupMethod handle, "name"
  2143.  
  2144.  
  2145. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  2146.  
  2147.  handle 
  2148.            Handle returned by PsnsInit 
  2149.  
  2150.  "name" 
  2151.            The name of the backup method to be deleted. 
  2152.  
  2153.  
  2154. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupMethod - Returns ΓòÉΓòÉΓòÉ
  2155.  
  2156.       PSNS_OK 
  2157.       PSNS_HANDLE_IN_USE 
  2158.       PSNS_COMMUNICATIONS_ERROR 
  2159.       PSNS_INVALID_HANDLE 
  2160.       PSNS_INVALID_BACKUP_METHOD 
  2161.       REXX_INVALID_HANDLE 
  2162.  
  2163.  
  2164. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  2165.  
  2166. If the named backup method exists, it will be deleted. 
  2167.  
  2168. name is in quotes to ensure that its case is correct. 
  2169.  
  2170.  
  2171. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  2172.  
  2173.      PsnsBackupMethodInfo 
  2174.  
  2175.      PsnsCopyBackupMethod 
  2176.  
  2177.      PsnsCreateBackupMethod 
  2178.  
  2179.      PsnsEstimateBackupMethod 
  2180.  
  2181.      PsnsListBackupMethods 
  2182.  
  2183.      PsnsRenameBackupMethod 
  2184.  
  2185.      PsnsRunBackupMethod 
  2186.  
  2187.  
  2188. ΓòÉΓòÉΓòÉ 4.25. PsnsDeleteBackupSet ΓòÉΓòÉΓòÉ
  2189.  
  2190. Select an item 
  2191.  
  2192.      Syntax 
  2193.      Parameters 
  2194.      Returns 
  2195.      Remarks 
  2196.      Example 
  2197.      Related functions 
  2198.  
  2199.  
  2200. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupSet - Syntax ΓòÉΓòÉΓòÉ
  2201.  
  2202. /***************************************************/
  2203. /* This function deletes a backup set              */
  2204. /***************************************************/
  2205.  
  2206. Call PsnsDeleteBackupSet handle, "name"
  2207.  
  2208.  
  2209. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupSet - Parameters ΓòÉΓòÉΓòÉ
  2210.  
  2211.  handle 
  2212.            Handle returned by PsnsInit 
  2213.  
  2214.  "name" 
  2215.            The name of the backup set to be deleted. 
  2216.  
  2217.  
  2218. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupSet - Returns ΓòÉΓòÉΓòÉ
  2219.  
  2220.       PSNS_OK 
  2221.       PSNS_HANDLE_IN_USE 
  2222.       PSNS_COMMUNICATIONS_ERROR 
  2223.       PSNS_INVALID_HANDLE 
  2224.       PSNS_INVALID_BACKUP_SET 
  2225.       PSNS_IN_USE 
  2226.       REXX_INVALID_HANDLE 
  2227.  
  2228.  
  2229. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupSet - Remarks ΓòÉΓòÉΓòÉ
  2230.  
  2231. If the named backup set exists, it will be deleted. You should take care not to 
  2232. delete a backup set which is referenced by any backup methods or restore 
  2233. methods; if you do, they will become invalid. 
  2234.  
  2235. name is in quotes to ensure that its case is correct. 
  2236.  
  2237.  
  2238. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteBackupSet - Related functions ΓòÉΓòÉΓòÉ
  2239.  
  2240.      PsnsBackupSetInfo 
  2241.  
  2242.      PsnsCreateBackupSet 
  2243.  
  2244.      PsnsEmptyBackupSet 
  2245.  
  2246.      PsnsGetBackupSetConfig 
  2247.  
  2248.      PsnsGetLogFile 
  2249.  
  2250.      PsnsListBackupSets 
  2251.  
  2252.      PsnsSetBackupSetConfig 
  2253.  
  2254.      PsnsTransferBackupSet 
  2255.  
  2256.      PsnsTransferIn 
  2257.  
  2258.  
  2259. ΓòÉΓòÉΓòÉ 4.26. PsnsDeleteEvent ΓòÉΓòÉΓòÉ
  2260.  
  2261. Select an item 
  2262.  
  2263.      Syntax 
  2264.      Parameters 
  2265.      Returns 
  2266.      Remarks 
  2267.      Example 
  2268.      Related functions 
  2269.  
  2270.  
  2271. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteEvent - Syntax ΓòÉΓòÉΓòÉ
  2272.  
  2273. /***************************************************/
  2274. /* This function deletes a scheduled event         */
  2275. /***************************************************/
  2276.  
  2277. Call PsnsDeleteEvent handle, eventID
  2278.  
  2279.  
  2280. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteEvent - Parameters ΓòÉΓòÉΓòÉ
  2281.  
  2282.  handle 
  2283.            Handle returned by PsnsInit 
  2284.  
  2285.  eventID 
  2286.            The ID of the event to be deleted. 
  2287.  
  2288.  
  2289. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteEvent - Returns ΓòÉΓòÉΓòÉ
  2290.  
  2291.       PSNS_OK 
  2292.       PSNS_HANDLE_IN_USE 
  2293.       PSNS_COMMUNICATIONS_ERROR 
  2294.       PSNS_INVALID_HANDLE 
  2295.       PSNS_INVALID_EVENT 
  2296.       PSNS_IN_USE 
  2297.       REXX_INVALID_HANDLE 
  2298.  
  2299.  
  2300. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteEvent - Remarks ΓòÉΓòÉΓòÉ
  2301.  
  2302. If an event exists with the given ID, it will be deleted. 
  2303.  
  2304.  
  2305. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteEvent - Related functions ΓòÉΓòÉΓòÉ
  2306.  
  2307.      PsnsActivateEvent 
  2308.  
  2309.      PsnsCopyEvent 
  2310.  
  2311.      PsnsCreateEvent 
  2312.  
  2313.      PsnsEventInfo 
  2314.  
  2315.      PsnsGetNextEvent 
  2316.  
  2317.      PsnsListEvents 
  2318.  
  2319.  
  2320. ΓòÉΓòÉΓòÉ 4.27. PsnsDeleteFileFilter ΓòÉΓòÉΓòÉ
  2321.  
  2322. Select an item 
  2323.  
  2324.      Syntax 
  2325.      Parameters 
  2326.      Returns 
  2327.      Remarks 
  2328.      Example 
  2329.      Related functions 
  2330.  
  2331.  
  2332. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilter - Syntax ΓòÉΓòÉΓòÉ
  2333.  
  2334. /***************************************************/
  2335. /* This function deletes a file filter             */
  2336. /***************************************************/
  2337.  
  2338. Call PsnsDeleteFileFilter handle, "name"
  2339.  
  2340.  
  2341. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilter - Parameters ΓòÉΓòÉΓòÉ
  2342.  
  2343.  handle 
  2344.            Handle returned by PsnsInit 
  2345.  
  2346.  "name" 
  2347.            The name of the file filter to be deleted. 
  2348.  
  2349.  
  2350. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilter - Returns ΓòÉΓòÉΓòÉ
  2351.  
  2352.       PSNS_OK 
  2353.       PSNS_HANDLE_IN_USE 
  2354.       PSNS_COMMUNICATIONS_ERROR 
  2355.       PSNS_INVALID_HANDLE 
  2356.       PSNS_INVALID_FILE_FILTER 
  2357.       PSNS_IN_USE 
  2358.       REXX_INVALID_HANDLE 
  2359.  
  2360.  
  2361. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilter - Remarks ΓòÉΓòÉΓòÉ
  2362.  
  2363. If the named file filter exists, it will be deleted. You should take care not 
  2364. to delete a file filter which is referenced by any backup methods, if you do, 
  2365. then the backup methods will become invalid. 
  2366.  
  2367. name is in quotes to ensure that its case is correct. 
  2368.  
  2369.  
  2370. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilter - Related functions ΓòÉΓòÉΓòÉ
  2371.  
  2372.      PsnsCopyFileFilter 
  2373.  
  2374.      PsnsCreateFileFilter 
  2375.  
  2376.      PsnsFileFilterInfo 
  2377.  
  2378.      PsnsListFileFilters 
  2379.  
  2380.      PsnsRenameFileFilter 
  2381.  
  2382.  
  2383. ΓòÉΓòÉΓòÉ 4.28. PsnsDeleteFileFilterRule ΓòÉΓòÉΓòÉ
  2384.  
  2385. Select an item 
  2386.  
  2387.      Syntax 
  2388.      Parameters 
  2389.      Returns 
  2390.      Remarks 
  2391.      Example 
  2392.      Related functions 
  2393.  
  2394.  
  2395. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilterRule - Syntax ΓòÉΓòÉΓòÉ
  2396.  
  2397. /***************************************************/
  2398. /* This function deletes a rule from a file filter */
  2399. /***************************************************/
  2400.  
  2401. Call PsnsDeleteFileFilterRule handle, "name", position
  2402.  
  2403.  
  2404. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilterRule - Parameters ΓòÉΓòÉΓòÉ
  2405.  
  2406.  handle 
  2407.            Handle returned by PsnsInit 
  2408.  
  2409.  "name" 
  2410.            The name of the file filter from which a rule is to be deleted. 
  2411.  
  2412.  position 
  2413.            Number of the rule to be deleted (the first rule is 1). 
  2414.  
  2415.  
  2416. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilterRule - Returns ΓòÉΓòÉΓòÉ
  2417.  
  2418.       PSNS_OK 
  2419.       PSNS_HANDLE_IN_USE 
  2420.       PSNS_COMMUNICATIONS_ERROR 
  2421.       PSNS_INVALID_HANDLE 
  2422.       PSNS_INVALID_FILE_FILTER 
  2423.       PSNS_INVALID_POSITION 
  2424.       PSNS_IN_USE 
  2425.       PSNS_READONLY 
  2426.       REXX_INVALID_HANDLE 
  2427.  
  2428.  
  2429. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilterRule - Remarks ΓòÉΓòÉΓòÉ
  2430.  
  2431. Use this function to delete a rule from a file filter. 
  2432.  
  2433. name is in quotes to ensure that its case is correct. 
  2434.  
  2435.  
  2436. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteFileFilterRule - Related functions ΓòÉΓòÉΓòÉ
  2437.  
  2438.      PsnsAddFileFilterRule 
  2439.  
  2440.      PsnsFileFilterRuleInfo 
  2441.  
  2442.      PsnsListFileFilterRule 
  2443.  
  2444.  
  2445. ΓòÉΓòÉΓòÉ 4.29. PsnsDeleteRestoreMethod ΓòÉΓòÉΓòÉ
  2446.  
  2447. Select an item 
  2448.  
  2449.      Syntax 
  2450.      Parameters 
  2451.      Returns 
  2452.      Remarks 
  2453.      Example 
  2454.      Related functions 
  2455.  
  2456.  
  2457. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  2458.  
  2459. /***************************************************/
  2460. /* This function deletes a restore method          */
  2461. /***************************************************/
  2462.  
  2463. Call PsnsDeleteRestoreMethod handle, "name"
  2464.  
  2465.  
  2466. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  2467.  
  2468.  handle 
  2469.            Handle returned by PsnsInit 
  2470.  
  2471.  "name" 
  2472.            The name of the method to be deleted. 
  2473.  
  2474.  
  2475. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  2476.  
  2477.       PSNS_OK 
  2478.       PSNS_HANDLE_IN_USE 
  2479.       PSNS_COMMUNICATIONS_ERROR 
  2480.       PSNS_INVALID_HANDLE 
  2481.       PSNS_INVALID_RESTORE_METHOD 
  2482.       PSNS_IN_USE 
  2483.       REXX_INVALID_HANDLE 
  2484.  
  2485.  
  2486. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  2487.  
  2488. If the named restore method exists, it will be deleted. 
  2489.  
  2490. name is in quotes to ensure that its case is correct. 
  2491.  
  2492.  
  2493. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  2494.  
  2495.      PsnsCopyRestoreMethod 
  2496.  
  2497.      PsnsCreateRestoreMethod 
  2498.  
  2499.      PsnsEstimateRestoreMethod 
  2500.  
  2501.      PsnsListRestoreMethods 
  2502.  
  2503.      PsnsRenameRestoreMethod 
  2504.  
  2505.      PsnsRestoreMethodInfo 
  2506.  
  2507.      PsnsRunRestoreMethod 
  2508.  
  2509.  
  2510. ΓòÉΓòÉΓòÉ 4.30. PsnsDeleteRulebook ΓòÉΓòÉΓòÉ
  2511.  
  2512. Select an item 
  2513.  
  2514.      Syntax 
  2515.      Parameters 
  2516.      Returns 
  2517.      Remarks 
  2518.      Example 
  2519.      Related functions 
  2520.  
  2521.  
  2522. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebook - Syntax ΓòÉΓòÉΓòÉ
  2523.  
  2524. /***************************************************/
  2525. /* This function deletes a rulebook                */
  2526. /***************************************************/
  2527.  
  2528. Call PsnsDeleteRulebook handle, "name"
  2529.  
  2530.  
  2531. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebook - Parameters ΓòÉΓòÉΓòÉ
  2532.  
  2533.  handle 
  2534.            Handle returned by PsnsInit 
  2535.  
  2536.  "name" 
  2537.            The name of the rulebook to be deleted. 
  2538.  
  2539.  
  2540. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebook - Returns ΓòÉΓòÉΓòÉ
  2541.  
  2542.       PSNS_OK 
  2543.       PSNS_HANDLE_IN_USE 
  2544.       PSNS_COMMUNICATIONS_ERROR 
  2545.       PSNS_INVALID_HANDLE 
  2546.       PSNS_INVALID_RULEBOOK 
  2547.       PSNS_IN_USE 
  2548.       REXX_INVALID_HANDLE 
  2549.  
  2550.  
  2551. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebook - Remarks ΓòÉΓòÉΓòÉ
  2552.  
  2553. If the named rulebook exists, it will be deleted. You should take care not to 
  2554. delete a rulebook which is referenced by any backup methods; if you do then the 
  2555. backup methods will become invalid. 
  2556.  
  2557. name is in quotes to ensure that its case is correct. 
  2558.  
  2559.  
  2560. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebook - Related functions ΓòÉΓòÉΓòÉ
  2561.  
  2562.      PsnsCopyRulebook 
  2563.  
  2564.      PsnsCreateRulebook 
  2565.  
  2566.      PsnsListRulebooks 
  2567.  
  2568.      PsnsRenameRulebook 
  2569.  
  2570.      PsnsRulebookInfo 
  2571.  
  2572.  
  2573. ΓòÉΓòÉΓòÉ 4.31. PsnsDeleteRulebookRule ΓòÉΓòÉΓòÉ
  2574.  
  2575. Select an item 
  2576.  
  2577.      Syntax 
  2578.      Parameters 
  2579.      Returns 
  2580.      Remarks 
  2581.      Example 
  2582.      Related functions 
  2583.  
  2584.  
  2585. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebookRule - Syntax ΓòÉΓòÉΓòÉ
  2586.  
  2587. /***************************************************/
  2588. /* This function deletes a rule from a rulebook    */
  2589. /***************************************************/
  2590.  
  2591. Call PsnsDeleteRulebookRule handle, "name", position
  2592.  
  2593.  
  2594. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebookRule - Parameters ΓòÉΓòÉΓòÉ
  2595.  
  2596.  handle 
  2597.            Handle returned by PsnsInit 
  2598.  
  2599.  "name" 
  2600.            The name of the rulebook from which a rule is to be deleted. 
  2601.  
  2602.  position 
  2603.            Number of the rule to be deleted (the first rule is 1). 
  2604.  
  2605.  
  2606. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebookRule - Returns ΓòÉΓòÉΓòÉ
  2607.  
  2608.       PSNS_OK 
  2609.       PSNS_HANDLE_IN_USE 
  2610.       PSNS_COMMUNICATIONS_ERROR 
  2611.       PSNS_INVALID_HANDLE 
  2612.       PSNS_INVALID_RULEBOOK 
  2613.       PSNS_INVALID_POSITION 
  2614.       PSNS_IN_USE 
  2615.       REXX_INVALID_HANDLE 
  2616.  
  2617.  
  2618. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebookRule - Remarks ΓòÉΓòÉΓòÉ
  2619.  
  2620. Use this function to delete a rule from a rulebook. 
  2621.  
  2622. name is in quotes to ensure that its case is correct. 
  2623.  
  2624.  
  2625. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteRulebookRule - Related functions ΓòÉΓòÉΓòÉ
  2626.  
  2627.      PsnsAddRulebookRule 
  2628.  
  2629.      PsnsListRulebookRule 
  2630.  
  2631.      PsnsRulebookRuleInfo 
  2632.  
  2633.  
  2634. ΓòÉΓòÉΓòÉ 4.32. PsnsDeleteStorageDevice ΓòÉΓòÉΓòÉ
  2635.  
  2636. Select an item 
  2637.  
  2638.      Syntax 
  2639.      Parameters 
  2640.      Returns 
  2641.      Remarks 
  2642.      Example 
  2643.      Related functions 
  2644.  
  2645.  
  2646. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteStorageDevice - Syntax ΓòÉΓòÉΓòÉ
  2647.  
  2648. /***************************************************/
  2649. /* This function deletes a storage device          */
  2650. /***************************************************/
  2651.  
  2652. Call PsnsDeleteStorageDevice handle, "storageDeviceName"
  2653.  
  2654.  
  2655. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteStorageDevice - Parameters ΓòÉΓòÉΓòÉ
  2656.  
  2657.  handle 
  2658.            Handle returned by PsnsInit 
  2659.  
  2660.  "storageDeviceName" 
  2661.            The name of the storage device type you wish to delete. 
  2662.  
  2663.  
  2664. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteStorageDevice - Returns ΓòÉΓòÉΓòÉ
  2665.  
  2666.       PSNS_OK 
  2667.       PSNS_HANDLE_IN_USE 
  2668.       PSNS_COMMUNICATIONS_ERROR 
  2669.       PSNS_INVALID_HANDLE 
  2670.       PSNS_INVALID_STORAGE_DEVICE 
  2671.       PSNS_IN_USE 
  2672.       PSNS_CANNOT_DELETE 
  2673.       REXX_INVALID_HANDLE 
  2674.  
  2675.  
  2676. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteStorageDevice - Remarks ΓòÉΓòÉΓòÉ
  2677.  
  2678. Use this function to delete a storage device. Some storage devices cannot be 
  2679. deleted; you also cannot delete a storage device which has any backup sets 
  2680. associated with it. 
  2681.  
  2682. storageDeviceName is in quotes to ensure that its case is correct. 
  2683.  
  2684.  
  2685. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteStorageDevice - Related functions ΓòÉΓòÉΓòÉ
  2686.  
  2687.      PsnsCreateStorageDevice 
  2688.  
  2689.      PsnsGetStorageDeviceConfig 
  2690.  
  2691.      PsnsListCreatableStorageDevices 
  2692.  
  2693.      PsnsListStorageDevices 
  2694.  
  2695.      PsnsRefreshStorageDevices 
  2696.  
  2697.      PsnsSetStorageDeviceConfig 
  2698.  
  2699.      PsnsStorageDeviceInfo 
  2700.  
  2701.  
  2702. ΓòÉΓòÉΓòÉ 4.33. PsnsDeleteVolume ΓòÉΓòÉΓòÉ
  2703.  
  2704. Select an item 
  2705.  
  2706.      Syntax 
  2707.      Parameters 
  2708.      Returns 
  2709.      Remarks 
  2710.      Example 
  2711.      Related functions 
  2712.  
  2713.  
  2714. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteVolume - Syntax ΓòÉΓòÉΓòÉ
  2715.  
  2716. /***************************************************/
  2717. /* This function deletes a volume                  */
  2718. /***************************************************/
  2719.  
  2720. Call PsnsDeleteVolume handle, volumeID
  2721.  
  2722.  
  2723. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteVolume - Parameters ΓòÉΓòÉΓòÉ
  2724.  
  2725.  handle 
  2726.            Handle returned by PsnsInit 
  2727.  
  2728.  volumeID 
  2729.            The ID of the volume to be deleted. 
  2730.  
  2731.  
  2732. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteVolume - Returns ΓòÉΓòÉΓòÉ
  2733.  
  2734.       PSNS_OK 
  2735.       PSNS_HANDLE_IN_USE 
  2736.       PSNS_COMMUNICATIONS_ERROR 
  2737.       PSNS_INVALID_HANDLE 
  2738.       PSNS_INVALID_VOLUME 
  2739.       PSNS_IN_USE 
  2740.       PSNS_CANNOT_DELETE 
  2741.       PSNS_FIXED_VOLUME 
  2742.       REXX_INVALID_HANDLE 
  2743.  
  2744.  
  2745. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteVolume - Remarks ΓòÉΓòÉΓòÉ
  2746.  
  2747. Use this function to delete a volume. Any data backed up to the volume will be 
  2748. lost. Fixed volumes (such as local fixed disks) cannot be deleted. 
  2749.  
  2750.  
  2751. ΓòÉΓòÉΓòÉ <hidden> PsnsDeleteVolume - Related functions ΓòÉΓòÉΓòÉ
  2752.  
  2753.      PsnsActivateVolume 
  2754.  
  2755.      PsnsAssociateVolume 
  2756.  
  2757.      PsnsCreateVolume 
  2758.  
  2759.      PsnsListVolumeBackupSets 
  2760.  
  2761.      PsnsListVolumes 
  2762.  
  2763.      PsnsVolumeInfo 
  2764.  
  2765.  
  2766. ΓòÉΓòÉΓòÉ 4.34. PsnsDropFiles ΓòÉΓòÉΓòÉ
  2767.  
  2768. Select an item 
  2769.  
  2770.      Syntax 
  2771.      Parameters 
  2772.      Returns 
  2773.      Remarks 
  2774.      Example 
  2775.      Related functions 
  2776.  
  2777.  
  2778. ΓòÉΓòÉΓòÉ <hidden> PsnsDropFiles - Syntax ΓòÉΓòÉΓòÉ
  2779.  
  2780. /***************************************************/
  2781. /* This function removes backed-up data for a list */
  2782. /* of files from a backup set.                     */
  2783. /***************************************************/
  2784.  
  2785. Call PsnsDropFiles handle, "backupsetName"
  2786.  
  2787.  
  2788. ΓòÉΓòÉΓòÉ <hidden> PsnsDropFiles - Parameters ΓòÉΓòÉΓòÉ
  2789.  
  2790.  handle 
  2791.            Handle returned by PsnsInit 
  2792.  
  2793.  "backupsetName" 
  2794.            The name of the backup set from which you wish to drop file(s). 
  2795.  
  2796.  
  2797. ΓòÉΓòÉΓòÉ <hidden> PsnsDropFiles - Returns ΓòÉΓòÉΓòÉ
  2798.  
  2799.       PSNS_OK 
  2800.       PSNS_HANDLE_IN_USE 
  2801.       PSNS_COMMUNICATIONS_ERROR 
  2802.       PSNS_INVALID_HANDLE 
  2803.       PSNS_INVALID_BACKUP_SET 
  2804.       PSNS_FILE_NOT_FOUND 
  2805.       PSNS_ARCHIVE_ERROR 
  2806.       PSNS_TRANSFERRED_OUT 
  2807.       REXX_INVALID_HANDLE 
  2808.       REXX_INVALID_PARAMETER 
  2809.  
  2810.  
  2811. ΓòÉΓòÉΓòÉ <hidden> PsnsDropFiles - Remarks ΓòÉΓòÉΓòÉ
  2812.  
  2813. Use this function to remove information about a list of files from a backup 
  2814. set. After this, you will no longer be able to restore the generation(s) of the 
  2815. file(s) you have dropped. OS/2 Warp Server Backup/Restore will be able to reuse 
  2816. the space on the volume(s) taken up by these files. 
  2817.  
  2818. Before calling this function, you should list the files and generations you 
  2819. want to drop by calling PsnsAddFile. 
  2820.  
  2821. backupsetName is in quotes to ensure that its case is correct. 
  2822.  
  2823.  
  2824. ΓòÉΓòÉΓòÉ <hidden> PsnsDropFiles - Related functions ΓòÉΓòÉΓòÉ
  2825.  
  2826.      PsnsAddFile 
  2827.  
  2828.      PsnsBackupFiles 
  2829.  
  2830.      PsnsListFiles 
  2831.  
  2832.      PsnsPurgeFiles 
  2833.  
  2834.      PsnsRestoreFiles 
  2835.  
  2836.  
  2837. ΓòÉΓòÉΓòÉ 4.35. PsnsEmptyBackupSet ΓòÉΓòÉΓòÉ
  2838.  
  2839. Select an item 
  2840.  
  2841.      Syntax 
  2842.      Parameters 
  2843.      Returns 
  2844.      Remarks 
  2845.      Example 
  2846.      Related functions 
  2847.  
  2848.  
  2849. ΓòÉΓòÉΓòÉ <hidden> PsnsEmptyBackupSet - Syntax ΓòÉΓòÉΓòÉ
  2850.  
  2851. /***************************************************/
  2852. /* This function destroys all backed-up data in a  */
  2853. /* backup set.                                     */
  2854. /***************************************************/
  2855.  
  2856. Call PsnsEmptyBackupSet handle, "name"
  2857.  
  2858.  
  2859. ΓòÉΓòÉΓòÉ <hidden> PsnsEmptyBackupSet - Parameters ΓòÉΓòÉΓòÉ
  2860.  
  2861.  handle 
  2862.            Handle returned by PsnsInit 
  2863.  
  2864.  "name" 
  2865.            The name of the backup set to be emptied. 
  2866.  
  2867.  
  2868. ΓòÉΓòÉΓòÉ <hidden> PsnsEmptyBackupSet - Returns ΓòÉΓòÉΓòÉ
  2869.  
  2870.       PSNS_OK 
  2871.       PSNS_HANDLE_IN_USE 
  2872.       PSNS_COMMUNICATIONS_ERROR 
  2873.       PSNS_INVALID_HANDLE 
  2874.       PSNS_INVALID_BACKUP_SET 
  2875.       PSNS_IN_USE 
  2876.       PSNS_ARCHIVE_ERROR 
  2877.       PSNS_TRANSFERRED_OUT 
  2878.       REXX_INVALID_HANDLE 
  2879.  
  2880.  
  2881. ΓòÉΓòÉΓòÉ <hidden> PsnsEmptyBackupSet - Remarks ΓòÉΓòÉΓòÉ
  2882.  
  2883. Use this function to destroy all backed-up data in a backup set. You will no 
  2884. longer be able to restore any of the files backed up to this backup set and 
  2885. OS/2 Warp Server Backup/Restore will be able to reuse the volumes which the 
  2886. backup set uses. The backup set itself is not deleted. 
  2887.  
  2888. name is in quotes to ensure that its case is correct. 
  2889.  
  2890.  
  2891. ΓòÉΓòÉΓòÉ <hidden> PsnsEmptyBackupSet - Related functions ΓòÉΓòÉΓòÉ
  2892.  
  2893.      PsnsBackupSetInfo 
  2894.  
  2895.      PsnsCreateBackupSet 
  2896.  
  2897.      PsnsDeleteBackupSet 
  2898.  
  2899.      PsnsGetBackupSetConfig 
  2900.  
  2901.      PsnsGetLogFile 
  2902.  
  2903.      PsnsListBackupSets 
  2904.  
  2905.      PsnsSetBackupSetConfig 
  2906.  
  2907.      PsnsTransferBackupSet 
  2908.  
  2909.      PsnsTransferIn 
  2910.  
  2911.  
  2912. ΓòÉΓòÉΓòÉ 4.36. PsnsEstimateBackupMethod ΓòÉΓòÉΓòÉ
  2913.  
  2914. Select an item 
  2915.  
  2916.      Syntax 
  2917.      Parameters 
  2918.      Returns 
  2919.      Remarks 
  2920.      Example 
  2921.      Related functions 
  2922.  
  2923.  
  2924. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  2925.  
  2926. /*****************************************************/
  2927. /* This function counts the files and folders which  */
  2928. /* would be backed up by a given backup method and   */
  2929. /* calculates the estimated time for the backup.     */
  2930. /*****************************************************/
  2931.  
  2932. Call PsnsEstimateBackupMethod handle, "backupName",
  2933.                               "stemname"
  2934.  
  2935.  
  2936. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  2937.  
  2938.  handle 
  2939.            Handle returned by PsnsInit 
  2940.  
  2941.  "backupName" 
  2942.            The name of the backup to be estimated. 
  2943.  
  2944.  "stemname" 
  2945.            The name of the stem in which the information is to be put. 
  2946.  
  2947.            The returned stemname values are: 
  2948.  
  2949.                                0files
  2950.                     The number of files. 
  2951.  
  2952.                                0folders
  2953.                     The number of folders. 
  2954.  
  2955.                                0bytes
  2956.                     The amount of bytes to be backed up. 
  2957.  
  2958.                                0time
  2959.                     Estimated length of time, in seconds, for the backup to 
  2960.                     take place. 
  2961.  
  2962.  
  2963. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateBackupMethod - Returns ΓòÉΓòÉΓòÉ
  2964.  
  2965.       PSNS_OK 
  2966.       PSNS_HANDLE_IN_USE 
  2967.       PSNS_COMMUNICATIONS_ERROR 
  2968.       PSNS_INVALID_HANDLE 
  2969.       PSNS_INVALID_BACKUP_METHOD 
  2970.       REXX_INVALID_HANDLE 
  2971.  
  2972.  
  2973. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  2974.  
  2975. Use this function to scan for files and folders which would be backed up by a 
  2976. backup method, and estimate how long the backup would take. OS/2 Warp Server 
  2977. Backup/Restore calculates the estimated time based on past backups to the same 
  2978. storage device. The information is returned in terms of compound variables, 
  2979. taking the stemname specified, and a tail added by the program. The compound 
  2980. variables are listed in the parameters section. 
  2981.  
  2982. The maximum size of backup that the estimate structure can deal with is 4.2 
  2983. Gigabytes. 
  2984.  
  2985. backupName and stemname are in quotes to ensure that their cases are correct. 
  2986.  
  2987.  
  2988. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  2989.  
  2990.      PsnsRunBackupMethod 
  2991.  
  2992.  
  2993. ΓòÉΓòÉΓòÉ 4.37. PsnsEstimateRestoreMethod ΓòÉΓòÉΓòÉ
  2994.  
  2995. Select an item 
  2996.  
  2997.      Syntax 
  2998.      Parameters 
  2999.      Returns 
  3000.      Remarks 
  3001.      Example 
  3002.      Related functions 
  3003.  
  3004.  
  3005. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  3006.  
  3007. /*****************************************************/
  3008. /* This function counts the files and folders which  */
  3009. /* would be restored by a given restore method.      */
  3010. /*****************************************************/
  3011.  
  3012. Call PsnsEstimateRestoreMethod handle, "restoreName",
  3013.                               "stemname"
  3014.  
  3015.  
  3016. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  3017.  
  3018.  handle 
  3019.            Handle returned by PsnsInit 
  3020.  
  3021.  "restoreName" 
  3022.            The name of the restore method to be estimated. 
  3023.  
  3024.  "stemname" 
  3025.            The name of the stem in which the information is to be put. 
  3026.  
  3027.            The returned stemname values are: 
  3028.  
  3029.                                0files
  3030.                     The number of files. 
  3031.  
  3032.                                0folders
  3033.                     The number of folders. 
  3034.  
  3035.                                0bytes
  3036.                     The amount of bytes to be restored. 
  3037.  
  3038.  
  3039. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  3040.  
  3041.       PSNS_OK 
  3042.       PSNS_HANDLE_IN_USE 
  3043.       PSNS_COMMUNICATIONS_ERROR 
  3044.       PSNS_INVALID_HANDLE 
  3045.       PSNS_INVALID_RESTORE_METHOD 
  3046.       PSNS_ARCHIVE_ERROR 
  3047.       REXX_INVALID_HANDLE 
  3048.  
  3049.  
  3050. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  3051.  
  3052. Use this function to scan for files and folders which would be restored by a 
  3053. restore method, and estimate how long the restore would take. OS/2 Warp Server 
  3054. Backup/Restore calculates the estimated time based on past restores from the 
  3055. same storage device. The information is returned in terms of compound 
  3056. variables, taking the stemname specified, and a tail added by the program. The 
  3057. compound variables are listed in the parameters section. 
  3058.  
  3059. The maximum size of restore that the estimate structure can deal with is 4.2 
  3060. Gigabytes. 
  3061.  
  3062. restoreName and stemname are in quotes to ensure that their cases are correct. 
  3063.  
  3064.  
  3065. ΓòÉΓòÉΓòÉ <hidden> PsnsEstimateRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  3066.  
  3067.      PsnsRunRestoreMethod 
  3068.  
  3069.  
  3070. ΓòÉΓòÉΓòÉ 4.38. PsnsEventInfo ΓòÉΓòÉΓòÉ
  3071.  
  3072. Select an item 
  3073.  
  3074.      Syntax 
  3075.      Parameters 
  3076.      Returns 
  3077.      Remarks 
  3078.      Example 
  3079.      Related functions 
  3080.  
  3081.  
  3082. ΓòÉΓòÉΓòÉ <hidden> PsnsEventInfo - Syntax ΓòÉΓòÉΓòÉ
  3083.  
  3084. /***************************************************/
  3085. /* This function gets or sets all the information  */
  3086. /* about a scheduled event                         */
  3087. /***************************************************/
  3088.  
  3089. Call PsnsEventInfo handle, "stemname", eventID
  3090.  
  3091.  
  3092. ΓòÉΓòÉΓòÉ <hidden> PsnsEventInfo - Parameters ΓòÉΓòÉΓòÉ
  3093.  
  3094.  handle 
  3095.            Handle returned by PsnsInit 
  3096.  
  3097.  "stemname" 
  3098.            The name of the stem from which information is to be taken and/or 
  3099.            put into. 
  3100.  
  3101.            Stemname parameters which may have their values changed or filled in 
  3102.            by the API are: 
  3103.  
  3104.                                0hours
  3105.                     The hour of the day when the event takes place. This 
  3106.                     parameter is used for all event types. 
  3107.  
  3108.                                0minutes
  3109.                     The minute of the hour when the event takes place. This 
  3110.                     parameter is used for all event types. 
  3111.  
  3112.                     Note:  For STARTUP events these parameters give the lapsed 
  3113.                     time in hours and minutes after startup when the event is 
  3114.                     to happen. 
  3115.  
  3116.            0days 
  3117.                     Bit-field specifying on which days the event will occur: 1 
  3118.                     = Monday, 2 = Tuesday, 4 = Wednesday and so on. This 
  3119.                     parameter is needed for NAMEDDAYS events. 
  3120.  
  3121.            0weeks 
  3122.                     Bit-field specifying in which weeks of the month the event 
  3123.                     will occur: 1 = First week, 2 = second, 4 = third, 8 = 
  3124.                     fourth, 16 = last. This parameter is needed for NAMEDDAYS 
  3125.                     events. 
  3126.  
  3127.            0day 
  3128.                     The day of the month on which the event takes place. This 
  3129.                     parameter is needed for MONTHLY events. 
  3130.  
  3131.            0backupMethod 
  3132.                     Name of the backup method which will be run. 
  3133.  
  3134.            0changedFilesOnly 
  3135.                     Permitted values are: 
  3136.  
  3137.                     YES      Only back up files which have changed since the 
  3138.                              last backup. 
  3139.                     NO       Back up all files, whether they have changed or 
  3140.                              not. 
  3141.                     AS_METHOD Use the backup method to decide whether to back 
  3142.                              up changed files. 
  3143.  
  3144.            0showPreview 
  3145.                     Permitted values are: 
  3146.  
  3147.                     YES      Show a preview before performing the backup. 
  3148.                     NO       Do not show a preview. 
  3149.                     AS_METHOD Use the backup method to decide whether to show a 
  3150.                              preview. 
  3151.  
  3152.            0active 
  3153.                     Permitted values are: 
  3154.  
  3155.                     1        The event is active. 
  3156.                     0        The event is inactive and will not occur. 
  3157.  
  3158.  eventID 
  3159.            The ID of the event to be changed. 
  3160.  
  3161.  
  3162. ΓòÉΓòÉΓòÉ <hidden> PsnsEventInfo - Returns ΓòÉΓòÉΓòÉ
  3163.  
  3164.       PSNS_OK 
  3165.       PSNS_HANDLE_IN_USE 
  3166.       PSNS_COMMUNICATIONS_ERROR 
  3167.       PSNS_INVALID_HANDLE 
  3168.       PSNS_INVALID_EVENT 
  3169.       PSNS_IN_USE 
  3170.       PSNS_INVALID_BACKUP_METHOD 
  3171.       PSNS_INVALID_MASK 
  3172.       PSNS_INVALID_TIME 
  3173.       REXX_INVALID_HANDLE 
  3174.       REXX_INVALID_MASK_NAME 
  3175.  
  3176.  
  3177. ΓòÉΓòÉΓòÉ <hidden> PsnsEventInfo - Remarks ΓòÉΓòÉΓòÉ
  3178.  
  3179. Use this function to change an event or inspect the current settings for it. In 
  3180. order to look at the settings, without changing any, simply do not create any 
  3181. compound variables, the API then fills in all the compound variables, so as to 
  3182. show the current settings. 
  3183.  
  3184. Putting in a parameter means that it will be changed, from its old value. It is 
  3185. not possible to change the type of an event with this call; to do that, the 
  3186. event must be deleted, and a new one created. 
  3187.  
  3188. For events of the STARTUP type, the time fields relate to how long after 
  3189. starting up the machine, the event takes place. 
  3190.  
  3191. stemname is in quotes to ensure that its case is correct. 
  3192.  
  3193.  
  3194. ΓòÉΓòÉΓòÉ <hidden> PsnsEventInfo - Related functions ΓòÉΓòÉΓòÉ
  3195.  
  3196.      PsnsActivateEvent 
  3197.  
  3198.      PsnsCopyEvent 
  3199.  
  3200.      PsnsCreateEvent 
  3201.  
  3202.      PsnsDeleteEvent 
  3203.  
  3204.      PsnsGetNextEvent 
  3205.  
  3206.      PsnsListEvents 
  3207.  
  3208.  
  3209. ΓòÉΓòÉΓòÉ 4.39. PsnsFileFilterInfo ΓòÉΓòÉΓòÉ
  3210.  
  3211. Select an item 
  3212.  
  3213.      Syntax 
  3214.      Parameters 
  3215.      Returns 
  3216.      Remarks 
  3217.      Example 
  3218.      Related functions 
  3219.  
  3220.  
  3221. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterInfo - Syntax ΓòÉΓòÉΓòÉ
  3222.  
  3223. /***************************************************/
  3224. /* This function gets or sets all the information  */
  3225. /* about a file filter                             */
  3226. /***************************************************/
  3227.  
  3228. Call PsnsFileFilterInfo handle, "stemname"
  3229.  
  3230.  
  3231. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterInfo - Parameters ΓòÉΓòÉΓòÉ
  3232.  
  3233.  handle 
  3234.            Handle returned by PsnsInit 
  3235.  
  3236.  "stemname" 
  3237.            The name of the stem from which information is to be taken and/or 
  3238.            put into. 
  3239.  
  3240.            Stemname parameters which may have their values changed or filled in 
  3241.            by the API are: 
  3242.  
  3243.                                0name
  3244.                     The name of the file filter. 
  3245.  
  3246.                                0description
  3247.                     Description of the file filter. 
  3248.  
  3249.                                0type
  3250.                     Permitted values are: 
  3251.  
  3252.                     TREE     Tree-based filter. 
  3253.                     LIST     Rule-based filter. 
  3254.  
  3255.                     Note:  All file filters are stored as rule-based filters; 
  3256.                     the type only affects how the file filter is displayed when 
  3257.                     it is edited. 
  3258.  
  3259.                                0searchfile
  3260.                     This field is used when listing file filters; it specifies 
  3261.                     a filename to match. All the file filters which select this 
  3262.                     file will be listed. 
  3263.  
  3264.  
  3265. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterInfo - Returns ΓòÉΓòÉΓòÉ
  3266.  
  3267.       PSNS_OK 
  3268.       PSNS_HANDLE_IN_USE 
  3269.       PSNS_COMMUNICATIONS_ERROR 
  3270.       PSNS_INVALID_HANDLE 
  3271.       PSNS_INVALID_FILE_FILTER 
  3272.       PSNS_IN_USE 
  3273.       PSNS_INVALID_FILE_FILTER_TYPE 
  3274.       PSNS_INVALID_MASK 
  3275.       REXX_INVALID_HANDLE 
  3276.       REXX_INVALID_MASK_NAME 
  3277.  
  3278.  
  3279. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterInfo - Remarks ΓòÉΓòÉΓòÉ
  3280.  
  3281. Use this function to change a file filter or to inspect the current settings 
  3282. for a file filter. In order to look at the settings, without changing any, do 
  3283. not create any compound variables, except that of the file filter name, the API 
  3284. then fills in all the compound variables, so as to show the current settings. 
  3285.  
  3286. Putting in a parameter means that it will be changed, from its old value. This, 
  3287. however is not true for the name field. It is not possible to change the name 
  3288. of a file filter with this call; to do that, use PsnsRenameFileFilter. 
  3289.  
  3290. stemname is in quotes to ensure that its case is correct. 
  3291.  
  3292.  
  3293. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterInfo - Related functions ΓòÉΓòÉΓòÉ
  3294.  
  3295.      PsnsCopyFileFilter 
  3296.  
  3297.      PsnsCreateFileFilter 
  3298.  
  3299.      PsnsDeleteFileFilter 
  3300.  
  3301.      PsnsListFileFilters 
  3302.  
  3303.      PsnsRenameFileFilter 
  3304.  
  3305.  
  3306. ΓòÉΓòÉΓòÉ 4.40. PsnsFileFilterRuleInfo ΓòÉΓòÉΓòÉ
  3307.  
  3308. Select an item 
  3309.  
  3310.      Syntax 
  3311.      Parameters 
  3312.      Returns 
  3313.      Remarks 
  3314.      Example 
  3315.      Related functions 
  3316.  
  3317.  
  3318. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterRuleInfo - Syntax ΓòÉΓòÉΓòÉ
  3319.  
  3320. /***************************************************/
  3321. /* This function gets or sets all the information  */
  3322. /* about a rule in a file filter                   */
  3323. /***************************************************/
  3324.  
  3325. Call PsnsFileFilterRuleInfo handle, "stemname",
  3326.                             position, "fileFilterName"
  3327.  
  3328.  
  3329. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterRuleInfo - Parameters ΓòÉΓòÉΓòÉ
  3330.  
  3331.  handle 
  3332.            Handle returned by PsnsInit 
  3333.  
  3334.  "stemname" 
  3335.            The name of the stem from which information is to be taken and/or 
  3336.            put into. 
  3337.  
  3338.            Stemname parameters which may have their values changed or filled in 
  3339.            by the API are: 
  3340.  
  3341.                                0drive
  3342.                     Drive letter to be included / excluded, or an asterisk (*) 
  3343.                     for all drives. 
  3344.  
  3345.                                0directory
  3346.                     Directory to be included / excluded. 
  3347.  
  3348.                                0pattern
  3349.                     Wildcard specifying which files to be included / excluded. 
  3350.  
  3351.                                0subdirectories
  3352.                     Permitted values are: 
  3353.  
  3354.                     1      Also include / exclude subdirectories in the 
  3355.                            specified directory. 
  3356.                     0      Do not include / exclude subdirectories. 
  3357.  
  3358.                                0include
  3359.                     Permitted values are: 
  3360.  
  3361.                     1      Include the specified files. 
  3362.                     0      Exclude the specified files. 
  3363.  
  3364.  position 
  3365.            Number of the rule to be inspected or changed (the first rule is 1). 
  3366.  
  3367.  "fileFilterName" 
  3368.            Name of the file filter to be inspected or changed. 
  3369.  
  3370.  
  3371. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterRuleInfo - Returns ΓòÉΓòÉΓòÉ
  3372.  
  3373.       PSNS_OK 
  3374.       PSNS_HANDLE_IN_USE 
  3375.       PSNS_COMMUNICATIONS_ERROR 
  3376.       PSNS_INVALID_HANDLE 
  3377.       PSNS_INVALID_FILE_FILTER 
  3378.       PSNS_IN_USE 
  3379.       PSNS_INVALID_POSITION 
  3380.       PSNS_INVALID_DRIVE 
  3381.       PSNS_INVALID_PATH 
  3382.       PSNS_INVALID_FILENAME 
  3383.       PSNS_READONLY 
  3384.       PSNS_INVALID_MASK 
  3385.       REXX_INVALID_HANDLE 
  3386.  
  3387.  
  3388. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterRuleInfo - Remarks ΓòÉΓòÉΓòÉ
  3389.  
  3390. Use this function to change a file filter rule or to inspect the current 
  3391. settings of a file filter rule. In order to look at the settings, without 
  3392. changing any, do not create any compound variables, the API then fills in all 
  3393. the compound variables, so as to show the current settings. 
  3394.  
  3395. Putting in a parameter means that it will be changed, from its old value. 
  3396.  
  3397. stemname and fileFilterName are in quotes to ensure their cases are correct. 
  3398.  
  3399.  
  3400. ΓòÉΓòÉΓòÉ <hidden> PsnsFileFilterRuleInfo - Related functions ΓòÉΓòÉΓòÉ
  3401.  
  3402.      PsnsAddFileFilterRule 
  3403.  
  3404.      PsnsDeleteFileFilterRule 
  3405.  
  3406.      PsnsListFileFilterRule 
  3407.  
  3408.  
  3409. ΓòÉΓòÉΓòÉ 4.41. PsnsGetBackupSetConfig ΓòÉΓòÉΓòÉ
  3410.  
  3411. Select an item 
  3412.  
  3413.      Syntax 
  3414.      Parameters 
  3415.      Returns 
  3416.      Remarks 
  3417.      Example 
  3418.      Related functions 
  3419.  
  3420.  
  3421. ΓòÉΓòÉΓòÉ <hidden> PsnsGetBackupSetConfig - Syntax ΓòÉΓòÉΓòÉ
  3422.  
  3423. /****************************************************/
  3424. /* This function gets configuration information for */
  3425. /* a backup set                                     */
  3426. /****************************************************/
  3427.  
  3428. Call PsnsGetBackupSetConfig handle, "stemname"
  3429.  
  3430.  
  3431. ΓòÉΓòÉΓòÉ <hidden> PsnsGetBackupSetConfig - Parameters ΓòÉΓòÉΓòÉ
  3432.  
  3433.  handle 
  3434.            Handle returned by PsnsInit 
  3435.  
  3436.  "stemname" 
  3437.            The name of the stem from which information is to be taken and put 
  3438.            into. 
  3439.  
  3440.            Stemname parameters used are: 
  3441.  
  3442.                                0name
  3443.                     The name of the backup set for which configuration 
  3444.                     information is to be obtained. The backup set name must be 
  3445.                     specified with this input parameter. 
  3446.  
  3447.                                0confString
  3448.                     This parameter will return the configuration string of the 
  3449.                     named backup set. For dual device backup sets this is the 
  3450.                     configuration string for the base storage device. 
  3451.  
  3452.                                0incConfString
  3453.                     For dual device backup sets, this parameter returns the 
  3454.                     configuration information for the incremental storage 
  3455.                     device. If the backup set is a single device backup set, 
  3456.                     then this parameter is set to a zero length string. 
  3457.  
  3458.  
  3459. ΓòÉΓòÉΓòÉ <hidden> PsnsGetBackupSetConfig - Returns ΓòÉΓòÉΓòÉ
  3460.  
  3461.       PSNS_OK 
  3462.       PSNS_HANDLE_IN_USE 
  3463.       PSNS_COMMUNICATIONS_ERROR 
  3464.       PSNS_INVALID_HANDLE 
  3465.       PSNS_INVALID_BACKUP_SET 
  3466.       PSNS_TOO_MUCH_DATA 
  3467.       PSNS_TRANSFERRED_OUT 
  3468.       REXX_INVALID_HANDLE 
  3469.  
  3470.  
  3471. ΓòÉΓòÉΓòÉ <hidden> PsnsGetBackupSetConfig - Remarks ΓòÉΓòÉΓòÉ
  3472.  
  3473. Use this function to get the current configuration information for a backup 
  3474. set, which is returned in stemname.0confString. The format of this information 
  3475. depends on the storage device which the backup set uses; to find out how all 
  3476. the standard OS/2 Warp Server Backup/Restore storage devices handle this, see 
  3477. Storage Device Configuration. 
  3478.  
  3479. stemname is in quotes to ensure that its case is correct. 
  3480.  
  3481.  
  3482. ΓòÉΓòÉΓòÉ <hidden> PsnsGetBackupSetConfig - Related functions ΓòÉΓòÉΓòÉ
  3483.  
  3484.      PsnsGetBackupSetConfig 
  3485.  
  3486.      PsnsSetBackupSetConfig 
  3487.  
  3488.      PsnsSetStorageDeviceConfig 
  3489.  
  3490.      PsnsTransferIn 
  3491.  
  3492.  
  3493. ΓòÉΓòÉΓòÉ 4.42. PsnsGetLogFile ΓòÉΓòÉΓòÉ
  3494.  
  3495. Select an item 
  3496.  
  3497.      Syntax 
  3498.      Parameters 
  3499.      Returns 
  3500.      Remarks 
  3501.      Example 
  3502.      Related functions 
  3503.  
  3504.  
  3505. ΓòÉΓòÉΓòÉ <hidden> PsnsGetLogFile - Syntax ΓòÉΓòÉΓòÉ
  3506.  
  3507. /****************************************************/
  3508. /* This function returns the name of the log file   */
  3509. /* for a backup set                                 */
  3510. /****************************************************/
  3511.  
  3512. Call PsnsGetLogFile handle, "stemname"
  3513.  
  3514.  
  3515. ΓòÉΓòÉΓòÉ <hidden> PsnsGetLogFile - Parameters ΓòÉΓòÉΓòÉ
  3516.  
  3517.  handle 
  3518.            Handle returned by PsnsInit 
  3519.  
  3520.  "stemname" 
  3521.            The name of the stem from which information is to be taken and put 
  3522.            into. Parameters used are: 
  3523.  
  3524.                                0name
  3525.                     The name of the backup set for which the log file is to be 
  3526.                     obtained. The backup set name must be specified with this 
  3527.                     input parameter. 
  3528.  
  3529.                                0logFile
  3530.                     This parameter returns the name of the requested log file. 
  3531.  
  3532.  
  3533. ΓòÉΓòÉΓòÉ <hidden> PsnsGetLogFile - Returns ΓòÉΓòÉΓòÉ
  3534.  
  3535.       PSNS_OK 
  3536.       PSNS_HANDLE_IN_USE 
  3537.       PSNS_COMMUNICATIONS_ERROR 
  3538.       PSNS_INVALID_HANDLE 
  3539.       PSNS_INVALID_BACKUP_SET 
  3540.       REXX_INVALID_HANDLE 
  3541.  
  3542.  
  3543. ΓòÉΓòÉΓòÉ <hidden> PsnsGetLogFile - Remarks ΓòÉΓòÉΓòÉ
  3544.  
  3545. Use this function to get the name of the log file for a backup set, this is 
  3546. returned in stemname.0logFile. If OS/2 Warp Server Backup/Restore is running 
  3547. locally, you will then be able to view, edit or delete the log file. 
  3548.  
  3549. stemname is in quotes to ensure that its case is correct. 
  3550.  
  3551.  
  3552. ΓòÉΓòÉΓòÉ <hidden> PsnsGetLogFile - Related functions ΓòÉΓòÉΓòÉ
  3553.  
  3554.      PsnsRunBackupMethod 
  3555.  
  3556.      PsnsRunRestoreMethod 
  3557.  
  3558.      PsnsTransferIn 
  3559.  
  3560.  
  3561. ΓòÉΓòÉΓòÉ 4.43. PsnsGetMessageText ΓòÉΓòÉΓòÉ
  3562.  
  3563. Select an item 
  3564.  
  3565.      Syntax 
  3566.      Parameters 
  3567.      Returns 
  3568.      Remarks 
  3569.      Example 
  3570.      Related functions 
  3571.  
  3572.  
  3573. ΓòÉΓòÉΓòÉ <hidden> PsnsGetMessageText - Syntax ΓòÉΓòÉΓòÉ
  3574.  
  3575. /***************************************************/
  3576. /* This function returns a text message associated */
  3577. /* with an API return code.                        */
  3578. /***************************************************/
  3579.  
  3580. Call PsnsGetMessageText handle, "returnVariable", returnCode
  3581.  
  3582.  
  3583. ΓòÉΓòÉΓòÉ <hidden> PsnsGetMessageText - Parameters ΓòÉΓòÉΓòÉ
  3584.  
  3585.  handle 
  3586.            Handle returned by PsnsInit 
  3587.  
  3588.  "returnVariable" 
  3589.            The REXX variable into which the text message is to be put. 
  3590.  
  3591.  returnCode 
  3592.            Return code for which you want to get a message 
  3593.  
  3594.  
  3595. ΓòÉΓòÉΓòÉ <hidden> PsnsGetMessageText - Returns ΓòÉΓòÉΓòÉ
  3596.  
  3597.       PSNS_OK 
  3598.       PSNS_HANDLE_IN_USE 
  3599.       PSNS_COMMUNICATIONS_ERROR 
  3600.       PSNS_INVALID_HANDLE 
  3601.       PSNS_INVALID_RC 
  3602.       PSNS_TOO_MUCH_DATA 
  3603.       REXX_INVALID_HANDLE 
  3604.  
  3605.  
  3606. ΓòÉΓòÉΓòÉ <hidden> PsnsGetMessageText - Remarks ΓòÉΓòÉΓòÉ
  3607.  
  3608. Use this function to retieve a message which contains a textual description of 
  3609. an OS/2 Warp Server Backup/Restore API return code. 
  3610.  
  3611. The text message is returned in the REXX variable returnVariable specified by 
  3612. the user. 
  3613.  
  3614. returnVariable is in quotes to ensure that its case is correct. 
  3615.  
  3616.  
  3617. ΓòÉΓòÉΓòÉ <hidden> PsnsGetMessageText - Related functions ΓòÉΓòÉΓòÉ
  3618.  
  3619. There are no related functions. 
  3620.  
  3621.  
  3622. ΓòÉΓòÉΓòÉ 4.44. PsnsGetNextEvent ΓòÉΓòÉΓòÉ
  3623.  
  3624. Select an item 
  3625.  
  3626.      Syntax 
  3627.      Parameters 
  3628.      Returns 
  3629.      Remarks 
  3630.      Example 
  3631.      Related functions 
  3632.  
  3633.  
  3634. ΓòÉΓòÉΓòÉ <hidden> PsnsGetNextEvent - Syntax ΓòÉΓòÉΓòÉ
  3635.  
  3636. /***************************************************/
  3637. /* This function calculates which scheduled event  */
  3638. /* is due to happen next, and returns information  */
  3639. /* about it.                                       */
  3640. /***************************************************/
  3641.  
  3642. Call PsnsGetNextEvent handle
  3643.  
  3644.  
  3645. ΓòÉΓòÉΓòÉ <hidden> PsnsGetNextEvent - Parameters ΓòÉΓòÉΓòÉ
  3646.  
  3647.  handle 
  3648.            Handle returned by PsnsInit 
  3649.  
  3650.  
  3651. ΓòÉΓòÉΓòÉ <hidden> PsnsGetNextEvent - Returns ΓòÉΓòÉΓòÉ
  3652.  
  3653.       PSNS_OK 
  3654.       PSNS_HANDLE_IN_USE 
  3655.       PSNS_COMMUNICATIONS_ERROR 
  3656.       PSNS_INVALID_HANDLE 
  3657.       PSNS_NO_EVENTS 
  3658.       REXX_INVALID_HANDLE 
  3659.  
  3660.  
  3661. ΓòÉΓòÉΓòÉ <hidden> PsnsGetNextEvent - Remarks ΓòÉΓòÉΓòÉ
  3662.  
  3663. Use this function to find out which scheduled event is due to happen next. It 
  3664. is possible that no events are currently scheduled to happen; in that case, 
  3665. PSNS_NO_EVENTS will be returned. 
  3666.  
  3667. The id of the next event to happen is returned in the REXX variable 
  3668. nextEventID. 
  3669.  
  3670.  
  3671. ΓòÉΓòÉΓòÉ <hidden> PsnsGetNextEvent - Related functions ΓòÉΓòÉΓòÉ
  3672.  
  3673.      PsnsActivateEvent 
  3674.  
  3675.      PsnsCopyEvent 
  3676.  
  3677.      PsnsCreateEvent 
  3678.  
  3679.      PsnsDeleteEvent 
  3680.  
  3681.      PsnsEventInfo 
  3682.  
  3683.      PsnsListEvents 
  3684.  
  3685.  
  3686. ΓòÉΓòÉΓòÉ 4.45. PsnsGetStorageDeviceConfig ΓòÉΓòÉΓòÉ
  3687.  
  3688. Select an item 
  3689.  
  3690.      Syntax 
  3691.      Parameters 
  3692.      Returns 
  3693.      Remarks 
  3694.      Example 
  3695.      Related functions 
  3696.  
  3697.  
  3698. ΓòÉΓòÉΓòÉ <hidden> PsnsGetStorageDeviceConfig - Syntax ΓòÉΓòÉΓòÉ
  3699.  
  3700. /****************************************************/
  3701. /* This function gets configuration information for */
  3702. /* a storage device                                 */
  3703. /****************************************************/
  3704.  
  3705. Call PsnsGetStorageDeviceConfig handle, "stemname"
  3706.  
  3707.  
  3708. ΓòÉΓòÉΓòÉ <hidden> PsnsGetStorageDeviceConfig - Parameters ΓòÉΓòÉΓòÉ
  3709.  
  3710.  handle 
  3711.            Handle returned by PsnsInit 
  3712.  
  3713.  "stemname" 
  3714.            The name of the stem from which information is to be taken and put 
  3715.            into. 
  3716.  
  3717.                                0storageDevice
  3718.                     The name of the storage device for which configuration 
  3719.                     information is to be obtained. The storage device name must 
  3720.                     be specified with this input parameter. 
  3721.  
  3722.                                0confString
  3723.                     This parameter will return the configuration string of the 
  3724.                     named storage device. 
  3725.  
  3726.  
  3727. ΓòÉΓòÉΓòÉ <hidden> PsnsGetStorageDeviceConfig - Returns ΓòÉΓòÉΓòÉ
  3728.  
  3729.       PSNS_OK 
  3730.       PSNS_HANDLE_IN_USE 
  3731.       PSNS_COMMUNICATIONS_ERROR 
  3732.       PSNS_INVALID_HANDLE 
  3733.       PSNS_INVALID_STORAGE_DEVICE 
  3734.       PSNS_TOO_MUCH_DATA 
  3735.       REXX_INVALID_HANDLE 
  3736.  
  3737.  
  3738. ΓòÉΓòÉΓòÉ <hidden> PsnsGetStorageDeviceConfig - Remarks ΓòÉΓòÉΓòÉ
  3739.  
  3740. Use this function to get the current configuration information for a storage 
  3741. device, which is returned in stemname.0confString. The format of this 
  3742. information depends on the storage device; to find out how all the standard 
  3743. OS/2 Warp Server Backup/Restore storage devices handle this, see Storage Device 
  3744. Configuration. 
  3745.  
  3746. stemname is in quotes to ensure that its case is correct. 
  3747.  
  3748.  
  3749. ΓòÉΓòÉΓòÉ <hidden> PsnsGetStorageDeviceConfig - Related functions ΓòÉΓòÉΓòÉ
  3750.  
  3751.      PsnsGetBackupSetConfig 
  3752.  
  3753.      PsnsSetBackupSetConfig 
  3754.  
  3755.      PsnsSetStorageDeviceConfig 
  3756.  
  3757.  
  3758. ΓòÉΓòÉΓòÉ 4.46. PsnsInit ΓòÉΓòÉΓòÉ
  3759.  
  3760. Select an item 
  3761.  
  3762.      Syntax 
  3763.      Parameters 
  3764.      Returns 
  3765.      Remarks 
  3766.      Example 
  3767.      Related functions 
  3768.  
  3769.  
  3770. ΓòÉΓòÉΓòÉ <hidden> PsnsInit - Syntax ΓòÉΓòÉΓòÉ
  3771.  
  3772. /***************************************************/
  3773. /* This function opens a connection to the API     */
  3774. /* server for use with subsequent API functions.   */
  3775. /***************************************************/
  3776.  
  3777. Call PsnsInit "handleName", "type", "data1", "data2"
  3778.  
  3779.  
  3780. ΓòÉΓòÉΓòÉ <hidden> PsnsInit - Parameters ΓòÉΓòÉΓòÉ
  3781.  
  3782.  "handleName" 
  3783.            The name of the REXX variable into which the handle number is to be 
  3784.            put. 
  3785.  
  3786.             "type"
  3787.            Permitted values are: 
  3788.  
  3789.            "PIPE"   Connect using named pipes. 
  3790.            "TCPIP"  Connect using TCP/IP sockets 
  3791.  
  3792.  "data1" and "data2" 
  3793.            Data about the connection. 
  3794.  
  3795.            To use named pipes, "data1" should contain the name of the server to 
  3796.            connect to, and "data2" should contain the name of the pipe to 
  3797.            connect to on that server.  If "data1" is empty, a local server is 
  3798.            used, while if "data2" is empty, a default pipe is used. 
  3799.  
  3800.            To use TCP/IP, "data1" should contain a string of the form 
  3801.            "hostname:port" or "hostname:service", specifying either a port 
  3802.            number or a service to be looked up in the TCP/IP services file; if 
  3803.            "data1" is empty or NULL, the port will be decided by looking up 
  3804.            psnsapi in the TCP/IP services file. 
  3805.  
  3806.  
  3807. ΓòÉΓòÉΓòÉ <hidden> PsnsInit - Returns ΓòÉΓòÉΓòÉ
  3808.  
  3809.       PSNS_OK 
  3810.       PSNS_COMMUNICATIONS_ERROR 
  3811.       PSNS_CANNOT_CONNECT 
  3812.       PSNS_NO_MORE_HANDLES 
  3813.       REXX_INVALID_HANDLE 
  3814.  
  3815.  
  3816. ΓòÉΓòÉΓòÉ <hidden> PsnsInit - Remarks ΓòÉΓòÉΓòÉ
  3817.  
  3818. This function must be called before using any other OS/2 Warp Server 
  3819. Backup/Restore functions. It opens a connection to the API server, which can be 
  3820. either local or remote. 
  3821.  
  3822. Only one API function can be called at a time. 
  3823.  
  3824. After all the API calls have been made, call PsnsTerm 
  3825.  
  3826. The handle number is returned in the REXX variable specified in handleName. 
  3827.  
  3828. handleName, type, data1 and data2 are in quotes to ensure that their cases are 
  3829. correct. 
  3830.  
  3831.  
  3832. ΓòÉΓòÉΓòÉ <hidden> PsnsInit - Related functions ΓòÉΓòÉΓòÉ
  3833.  
  3834.      PsnsTerm 
  3835.  
  3836.  
  3837. ΓòÉΓòÉΓòÉ 4.47. PsnsListBackupMethods ΓòÉΓòÉΓòÉ
  3838.  
  3839. Select an item 
  3840.  
  3841.      Syntax 
  3842.      Parameters 
  3843.      Returns 
  3844.      Remarks 
  3845.      Example 
  3846.      Related functions 
  3847.  
  3848.  
  3849. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupMethods - Syntax ΓòÉΓòÉΓòÉ
  3850.  
  3851. /***************************************************/
  3852. /* This function lists all the backup methods and  */
  3853. /* their current settings                          */
  3854. /***************************************************/
  3855.  
  3856. Call PsnsListBackupMethods handle, "stemname"
  3857.  
  3858.  
  3859. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupMethods - Parameters ΓòÉΓòÉΓòÉ
  3860.  
  3861.  handle 
  3862.            Handle returned by PsnsInit 
  3863.  
  3864.  "stemname" 
  3865.            The name of the stem into which the information is to be put. 
  3866.  
  3867.            The returned stemname parameter values are preceded by a list 
  3868.            position number for the returned item in the form: 
  3869.  
  3870.                         stemname.n.parameter value
  3871.            where n is the list position number. 
  3872.  
  3873.            The returned stemname parameter values are: 
  3874.  
  3875.                                n.0name
  3876.                     The name of the backup method. 
  3877.  
  3878.                                n.0description
  3879.                     The description of the backup method. 
  3880.  
  3881.                                n.0allFiles
  3882.                     Possible values are: 
  3883.  
  3884.                     1      Allow backup of any file; the drive, directory and 
  3885.                            subdirectories fields are ignored. 
  3886.                     0      Allow backup of files specified by the drive, 
  3887.                            directory and subdirectories fields. 
  3888.  
  3889.                                n.0drive
  3890.                     Drive letter from which to back up files. An asterisk (*) 
  3891.                     means all drives. 
  3892.  
  3893.                                n.0directory
  3894.                     The directory from which to back up files. 
  3895.  
  3896.                                n.0subdirectories
  3897.                     Possible values are: 
  3898.  
  3899.                     1      Include subdirectories of the specified directory. 
  3900.                     0      Do not include subdirectories. 
  3901.  
  3902.                                n.0compression
  3903.                     Possible values are: 
  3904.  
  3905.                     NOCOMPRESSION       Files are not compressed. 
  3906.                     COMPRESSION         Files are compressed. 
  3907.                     DEFAULT             Files are compressed using default 
  3908.                                         compression. 
  3909.  
  3910.                                n.0generations
  3911.                     Number of generations of files to keep backed up. 
  3912.  
  3913.                                n.0useRulebook
  3914.                     Possible values are: 
  3915.  
  3916.                     1      The rulebook named in rulebook is used. The 
  3917.                            compression and generations fields are ignored. 
  3918.                     0      A rulebook is not used. The settings in compression 
  3919.                            and generations are used. The rulebook field is 
  3920.                            ignored. 
  3921.  
  3922.                                n.0rulebook
  3923.                     The name of the rulebook used. 
  3924.  
  3925.                                n.0useFileFilter
  3926.                     Possible values are: 
  3927.  
  3928.                     1      The file filter named in fileFilter is used to 
  3929.                            decide which files to back up. 
  3930.                     0      All the files in the selected directory are backed 
  3931.                            up. fileFilter is ignored. 
  3932.  
  3933.                                n.0fileFilter
  3934.                     The name of the file filter used. 
  3935.  
  3936.                                n.0changedFilesOnly
  3937.                     Possible values are: 
  3938.  
  3939.                     1      Only files which have changed since the last backup 
  3940.                            to this backup set are backed up. 
  3941.                     0      All files are backed up, regardless of whether they 
  3942.                            have changed. 
  3943.  
  3944.                                n.0preview
  3945.                     Possible values are: 
  3946.  
  3947.                     1        A preview is shown before the backup which allows 
  3948.                              the user to select or deselect individual files. 
  3949.                     0        A preview is not shown before the backup. 
  3950.  
  3951.                     Note:  Showing a preview is only useful if the backup 
  3952.                     method is to be run from the OS/2 Warp Server 
  3953.                     Backup/Restore window; it is not possible to show a preview 
  3954.                     when running a backup method using the API. 
  3955.  
  3956.                                n.0backupSet
  3957.                     The backup set to which data is backed up. 
  3958.  
  3959.  In addition to the returned parameter values given above, the number of items 
  3960.  in the list is returned in: 
  3961.  
  3962.     stemname.0
  3963.  
  3964.  For more information on this topic, see Listing functions 
  3965.  
  3966.  
  3967. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupMethods - Returns ΓòÉΓòÉΓòÉ
  3968.  
  3969.       PSNS_OK 
  3970.       PSNS_HANDLE_IN_USE 
  3971.       PSNS_COMMUNICATIONS_ERROR 
  3972.       PSNS_INVALID_HANDLE 
  3973.       PSNS_INVALID_LIST_HANDLE 
  3974.       PSNS_NO_MORE_HANDLES 
  3975.       REXX_INVALID_HANDLE 
  3976.       REXX_INVALID_PARAMETER 
  3977.  
  3978.  
  3979. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupMethods - Remarks ΓòÉΓòÉΓòÉ
  3980.  
  3981. Use this function to list all the backup methods. The information is returned 
  3982. in the form of compound variables, taking the stemname specified, the number of 
  3983. the list item, and a tail added by the program. The compound variables are 
  3984. listed in the parameters section. 
  3985.  
  3986. "stemname.0", is set to the number of items in the list, so as to ensure that 
  3987. all the list items are looked at. 
  3988.  
  3989. stemname is in quotes to ensure that its case is correct. 
  3990.  
  3991.  
  3992. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupMethods - Related functions ΓòÉΓòÉΓòÉ
  3993.  
  3994.      PsnsBackupMethodInfo 
  3995.  
  3996.      PsnsCopyBackupMethod 
  3997.  
  3998.      PsnsCreateBackupMethod 
  3999.  
  4000.      PsnsDeleteBackupMethod 
  4001.  
  4002.      PsnsEstimateBackupMethod 
  4003.  
  4004.      PsnsRenameBackupMethod 
  4005.  
  4006.      PsnsRunBackupMethod 
  4007.  
  4008.  
  4009. ΓòÉΓòÉΓòÉ 4.48. PsnsListBackupSets ΓòÉΓòÉΓòÉ
  4010.  
  4011. Select an item 
  4012.  
  4013.      Syntax 
  4014.      Parameters 
  4015.      Returns 
  4016.      Remarks 
  4017.      Example 
  4018.      Related functions 
  4019.  
  4020.  
  4021. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupSets - Syntax ΓòÉΓòÉΓòÉ
  4022.  
  4023. /***************************************************/
  4024. /* This function lists all the backup sets and     */
  4025. /* their current settings                          */
  4026. /***************************************************/
  4027.  
  4028. Call PsnsListBackupSets handle, "stemname"
  4029.  
  4030.  
  4031. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupSets - Parameters ΓòÉΓòÉΓòÉ
  4032.  
  4033.  handle 
  4034.            Handle returned by PsnsInit 
  4035.  
  4036.  "stemname" 
  4037.            The name of the stem into which the information is to be put. 
  4038.  
  4039.            The returned stemname parameter values are preceded by a list 
  4040.            position number for the returned item in the form: 
  4041.  
  4042.                         stemname.n.parameter value
  4043.            where n is the list position number. 
  4044.  
  4045.            The returned stemname parameter values are: 
  4046.  
  4047.                                n.0name
  4048.                     The name of the backup set. 
  4049.  
  4050.                                n.0description
  4051.                     The description of the backup set. 
  4052.  
  4053.                                n.0storageDevice
  4054.                     The storage device which the backup set uses. For dual 
  4055.                     device backup sets this is the base device. 
  4056.  
  4057.                                n.0incStorageDevice
  4058.                     For single device backup sets this is a zero length string. 
  4059.                     For dual device backup sets this is the device which 
  4060.                     incremental backups are written to. Note that once a backup 
  4061.                     set has been created it cannot be changed from a single 
  4062.                     device backup set to a dual device backup set or 
  4063.                     vice-versa. 
  4064.  
  4065.                                n.0transferredIn
  4066.                     Possible values are: 
  4067.  
  4068.                     1      The backup set is transferred in and available for 
  4069.                            use. 
  4070.                     0      Otherwise. 
  4071.  
  4072.  In addition to the returned parameter values given above, the number of items 
  4073.  in the list is returned in: 
  4074.  
  4075.     stemname.0
  4076.  
  4077.  For more information on this topic, see Listing functions 
  4078.  
  4079.  
  4080. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupSets - Returns ΓòÉΓòÉΓòÉ
  4081.  
  4082.       PSNS_OK 
  4083.       PSNS_HANDLE_IN_USE 
  4084.       PSNS_COMMUNICATIONS_ERROR 
  4085.       PSNS_INVALID_HANDLE 
  4086.       PSNS_INVALID_LIST_HANDLE 
  4087.       PSNS_NO_MORE_HANDLES 
  4088.       PSNS_INVALID_MASK 
  4089.       REXX_INVALID_HANDLE 
  4090.  
  4091.  
  4092. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupSets - Remarks ΓòÉΓòÉΓòÉ
  4093.  
  4094. Use this function to list all the backup sets. The information is returned in 
  4095. the form of compound variables, taking the stemname specified, the number of 
  4096. the list item, and a tail added by the program. The compound variables are 
  4097. listed in the parameters section. 
  4098.  
  4099. "stemname.0", is set to the number of items in the list, so as to ensure that 
  4100. all the list items are looked at. 
  4101.  
  4102. stemname is in quotes to ensure that its case is correct. 
  4103.  
  4104.  
  4105. ΓòÉΓòÉΓòÉ <hidden> PsnsListBackupSets - Related functions ΓòÉΓòÉΓòÉ
  4106.  
  4107.      PsnsBackupSetInfo 
  4108.  
  4109.      PsnsCreateBackupSet 
  4110.  
  4111.      PsnsDeleteBackupSet 
  4112.  
  4113.      PsnsEmptyBackupSet 
  4114.  
  4115.      PsnsGetBackupSetConfig 
  4116.  
  4117.      PsnsGetLogFile 
  4118.  
  4119.      PsnsSetBackupSetConfig 
  4120.  
  4121.      PsnsTransferBackupSet 
  4122.  
  4123.      PsnsTransferIn 
  4124.  
  4125.  
  4126. ΓòÉΓòÉΓòÉ 4.49. PsnsListCreatableStorageDevices ΓòÉΓòÉΓòÉ
  4127.  
  4128. Select an item 
  4129.  
  4130.      Syntax 
  4131.      Parameters 
  4132.      Returns 
  4133.      Remarks 
  4134.      Example 
  4135.      Related functions 
  4136.  
  4137.  
  4138. ΓòÉΓòÉΓòÉ <hidden> PsnsListCreatableStorageDevices - Syntax ΓòÉΓòÉΓòÉ
  4139.  
  4140. /****************************************************/
  4141. /* This function lists all the creatable storage    */
  4142. /* device types                                     */
  4143. /****************************************************/
  4144.  
  4145. Call PsnsListCreatableStorageDevices handle, "stemname"
  4146.  
  4147.  
  4148. ΓòÉΓòÉΓòÉ <hidden> PsnsListCreatableStorageDevices - Parameters ΓòÉΓòÉΓòÉ
  4149.  
  4150.  handle 
  4151.            Handle returned by PsnsInit 
  4152.  
  4153.  "stemname" 
  4154.            The name of the stem into which the information is to be put. 
  4155.  
  4156.            The returned stemname parameter values are preceded by a list 
  4157.            position number for the returned item in the form: 
  4158.  
  4159.                         stemname.n.parameter value
  4160.            where n is the list position number. 
  4161.  
  4162.            The returned stemname parameter values are: 
  4163.  
  4164.                                n.0name
  4165.                     The name of the storage device. 
  4166.  
  4167.                                n.0dllName
  4168.                     The name of the Dynamic Link Library (DLL) which implements 
  4169.                     the storage device. 
  4170.  
  4171.  In addition to the returned parameter values given above, the number of items 
  4172.  in the list is returned in: 
  4173.  
  4174.     stemname.0
  4175.  
  4176.  For more information on this topic, see Listing functions 
  4177.  
  4178.  
  4179. ΓòÉΓòÉΓòÉ <hidden> PsnsListCreatableStorageDevices - Returns ΓòÉΓòÉΓòÉ
  4180.  
  4181.       PSNS_OK 
  4182.       PSNS_HANDLE_IN_USE 
  4183.       PSNS_COMMUNICATIONS_ERROR 
  4184.       PSNS_INVALID_HANDLE 
  4185.       PSNS_INVALID_LIST_HANDLE 
  4186.       PSNS_NO_MORE_HANDLES 
  4187.       PSNS_INVALID_MASK 
  4188.       REXX_INVALID_HANDLE 
  4189.  
  4190.  
  4191. ΓòÉΓòÉΓòÉ <hidden> PsnsListCreatableStorageDevices - Remarks ΓòÉΓòÉΓòÉ
  4192.  
  4193. Use this function to list all the creatable storage devices. The information is 
  4194. returned in the form of compound variables, taking the stemname specified, the 
  4195. number of the list item, and a tail added by the program. The compound 
  4196. variables are listed in the parameters section. 
  4197.  
  4198. "stemname.0", is set to the number of items in the list, so as to ensure that 
  4199. all the list items are looked at. 
  4200.  
  4201. stemname is in quotes to ensure that its case is correct. 
  4202.  
  4203.  
  4204. ΓòÉΓòÉΓòÉ <hidden> PsnsListCreatableStorageDevices - Related functions ΓòÉΓòÉΓòÉ
  4205.  
  4206.      PsnsCreateStorageDevice 
  4207.  
  4208.      PsnsDeleteStorageDevice 
  4209.  
  4210.      PsnsGetStorageDeviceConfig 
  4211.  
  4212.      PsnsListStorageDevices 
  4213.  
  4214.      PsnsRefreshStorageDevices 
  4215.  
  4216.      PsnsSetStorageDeviceConfig 
  4217.  
  4218.      PsnsStorageDeviceInfo 
  4219.  
  4220.  
  4221. ΓòÉΓòÉΓòÉ 4.50. PsnsListDefaults ΓòÉΓòÉΓòÉ
  4222.  
  4223. Select an item 
  4224.  
  4225.      Syntax 
  4226.      Parameters 
  4227.      Returns 
  4228.      Remarks 
  4229.      Example 
  4230.      Related functions 
  4231.  
  4232.  
  4233. ΓòÉΓòÉΓòÉ <hidden> PsnsListDefaults - Syntax ΓòÉΓòÉΓòÉ
  4234.  
  4235. /***************************************************/
  4236. /* This function lists the default file filter,    */
  4237. /* rulebook, backup set, compression and number of */
  4238. /* generations                                     */
  4239. /***************************************************/
  4240.  
  4241. Call PsnsListDefaults handle, "stemname"
  4242.  
  4243.  
  4244. ΓòÉΓòÉΓòÉ <hidden> PsnsListDefaults - Parameters ΓòÉΓòÉΓòÉ
  4245.  
  4246.  handle 
  4247.            Handle returned by PsnsInit 
  4248.  
  4249.  "stemname" 
  4250.            The name of the stem into which the information is to be put. 
  4251.  
  4252.            Parameter values returned are: 
  4253.  
  4254.                                0compression
  4255.                     Possible values are: 
  4256.  
  4257.                     1      Do compress data by default. 
  4258.                     0      Do not compress data by default. 
  4259.  
  4260.                                0generations
  4261.                     Default number of generations to keep backed up. 
  4262.  
  4263.                                0rulebook
  4264.                     The name of the default rulebook. 
  4265.  
  4266.                                0fileFilter
  4267.                     The name of the default file filter. 
  4268.  
  4269.                                0backupSet
  4270.                     The name of the default backup set. 
  4271.  
  4272.  
  4273. ΓòÉΓòÉΓòÉ <hidden> PsnsListDefaults - Returns ΓòÉΓòÉΓòÉ
  4274.  
  4275.       PSNS_OK 
  4276.       PSNS_HANDLE_IN_USE 
  4277.       PSNS_COMMUNICATIONS_ERROR 
  4278.       PSNS_INVALID_HANDLE 
  4279.       PSNS_INVALID_COMPRESSION 
  4280.       PSNS_INVALID_GENERATIONS 
  4281.       PSNS_INVALID_RULEBOOK 
  4282.       PSNS_INVALID_FILE_FILTER 
  4283.       REXX_INVALID_HANDLE 
  4284.  
  4285.  
  4286. ΓòÉΓòÉΓòÉ <hidden> PsnsListDefaults - Remarks ΓòÉΓòÉΓòÉ
  4287.  
  4288. Use this function to inspect the default file filter, rulebook, backup set, 
  4289. compression and number of generations to be kept. The information is returned 
  4290. in the form of compound variables, taking the stemname specified, and a tail 
  4291. added by the program. The compound variables are listed in the parameters 
  4292. section. 
  4293.  
  4294. To change the defaults, use PsnsListDefaultsInfo. 
  4295.  
  4296. stemname is in quotes to ensure that its case is correct. 
  4297.  
  4298.  
  4299. ΓòÉΓòÉΓòÉ <hidden> PsnsListDefaults - Related functions ΓòÉΓòÉΓòÉ
  4300.  
  4301.      PsnsDefaultsInfo 
  4302.  
  4303.      PsnsListSettings 
  4304.  
  4305.      PsnsSettingsInfo 
  4306.  
  4307.  
  4308. ΓòÉΓòÉΓòÉ 4.51. PsnsListEvents ΓòÉΓòÉΓòÉ
  4309.  
  4310. Select an item 
  4311.  
  4312.      Syntax 
  4313.      Parameters 
  4314.      Returns 
  4315.      Remarks 
  4316.      Example 
  4317.      Related functions 
  4318.  
  4319.  
  4320. ΓòÉΓòÉΓòÉ <hidden> PsnsListEvents - Syntax ΓòÉΓòÉΓòÉ
  4321.  
  4322. /***************************************************/
  4323. /* This function lists scheduled events            */
  4324. /***************************************************/
  4325.  
  4326. Call PsnsListEvents handle, "stemname"
  4327.  
  4328.  
  4329. ΓòÉΓòÉΓòÉ <hidden> PsnsListEvents - Parameters ΓòÉΓòÉΓòÉ
  4330.  
  4331.  handle 
  4332.            Handle returned by PsnsInit 
  4333.  
  4334.  "stemname" 
  4335.            The name of the stem into which the information is to be put. 
  4336.  
  4337.            The returned stemname parameter values are preceded by a list 
  4338.            position number for the returned item in the form: 
  4339.  
  4340.                         stemname.n.parameter value
  4341.            where n is the list position number. 
  4342.  
  4343.            The returned stemname parameter values are: 
  4344.  
  4345.                                n.0id
  4346.                     The ID of the event. 
  4347.  
  4348.                                n.0type
  4349.                     The type of event created. Possible values are: 
  4350.  
  4351.                     REGULAR       A regular interval event. 
  4352.                     DAILY         A daily event. 
  4353.                     STARTUP       A startup event. 
  4354.                     NAMEDDAYS     A named day event. 
  4355.                     MONTHLY       A monthly event. 
  4356.  
  4357.                                n.0hours
  4358.                     The hour of the day when the event takes place. This 
  4359.                     parameter is used for all event types. 
  4360.  
  4361.                                n.0minutes
  4362.                     The minute of the hour when the event takes place. This 
  4363.                     parameter is used for all event types. 
  4364.  
  4365.                     Note:  For STARTUP events these parameters give the lapsed 
  4366.                     time in hours and minutes after startup when the event is 
  4367.                     to happen. 
  4368.  
  4369.                                n.0days
  4370.                     Bit-field specifying on which days the event will occur: 1 
  4371.                     = Monday, 2 = Tuesday, 4 = Wednesday and so on. This 
  4372.                     parameter is used for NAMEDDAYS events. 
  4373.  
  4374.                                n.0weeks
  4375.                     Bit-field specifying in which weeks of the month the event 
  4376.                     will occur: 1 = First week, 2 = second, 4 = third, 8 = 
  4377.                     fourth, 16 = last. This parameter is used for NAMEDDAYS 
  4378.                     events. 
  4379.  
  4380.                                n.0day
  4381.                     The day of the month on which the event takes place. This 
  4382.                     parameter is used for MONTHLY events. 
  4383.  
  4384.                                n.0backupMethod
  4385.                     The name of the backup method which is run. 
  4386.  
  4387.                                n.0changedFilesOnly
  4388.                     Possible values are: 
  4389.  
  4390.                     YES      Only files which have changed since the last 
  4391.                              backup are backed up. 
  4392.                     NO       All files are backed up, regardless of their 
  4393.                              changed status. 
  4394.                     AS_METHOD The backup method is used to decide whether to 
  4395.                              back up changed files. 
  4396.  
  4397.                                n.0showPreview
  4398.                     Possible values are: 
  4399.  
  4400.                     YES      A preview is shown before performing the backup. 
  4401.                     NO       A preview is not shown. 
  4402.                     AS_METHOD The backup method is used to decide whether or 
  4403.                              not to show a preview. 
  4404.  
  4405.                                n.0active
  4406.                     Possible values are: 
  4407.  
  4408.                     1        The event is active. 
  4409.                     0        The event is inactive and will not occur. 
  4410.  
  4411.  In addition to the returned parameter values given above, the number of items 
  4412.  in the list is returned in: 
  4413.  
  4414.     stemname.0
  4415.  
  4416.  For more information on this topic, see Listing functions 
  4417.  
  4418.  
  4419. ΓòÉΓòÉΓòÉ <hidden> PsnsListEvents - Returns ΓòÉΓòÉΓòÉ
  4420.  
  4421.       PSNS_OK 
  4422.       PSNS_HANDLE_IN_USE 
  4423.       PSNS_COMMUNICATIONS_ERROR 
  4424.       PSNS_INVALID_HANDLE 
  4425.       PSNS_INVALID_LIST_HANDLE 
  4426.       PSNS_NO_MORE_HANDLES 
  4427.       PSNS_INVALID_MASK 
  4428.       REXX_INVALID_HANDLE 
  4429.       REXX_INVALID_PARAMETER 
  4430.  
  4431.  
  4432. ΓòÉΓòÉΓòÉ <hidden> PsnsListEvents - Remarks ΓòÉΓòÉΓòÉ
  4433.  
  4434. Use this function to view the events. The information is returned in the form 
  4435. of compound variables, taking the stemname specified, the number of the list 
  4436. item, and a tail added by the program. The compound variables are listed in the 
  4437. parameters section. 
  4438.  
  4439. "stemname.0", is set to the number of items in the list, so as to ensure that 
  4440. all the list items are looked at. 
  4441.  
  4442. stemname is in quotes to ensure that its case is correct. 
  4443.  
  4444.  
  4445. ΓòÉΓòÉΓòÉ <hidden> PsnsListEvents - Related functions ΓòÉΓòÉΓòÉ
  4446.  
  4447.      PsnsActivateEvent 
  4448.  
  4449.      PsnsCopyEvent 
  4450.  
  4451.      PsnsCreateEvent 
  4452.  
  4453.      PsnsDeleteEvent 
  4454.  
  4455.      PsnsEventInfo 
  4456.  
  4457.      PsnsGetNextEvent 
  4458.  
  4459.  
  4460. ΓòÉΓòÉΓòÉ 4.52. PsnsListFileFilterRule ΓòÉΓòÉΓòÉ
  4461.  
  4462. Select an item 
  4463.  
  4464.      Syntax 
  4465.      Parameters 
  4466.      Returns 
  4467.      Remarks 
  4468.      Example 
  4469.      Related functions 
  4470.  
  4471.  
  4472. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilterRule - Syntax ΓòÉΓòÉΓòÉ
  4473.  
  4474. /****************************************************/
  4475. /* This function lists the settings for a given     */
  4476. /* file filter rule.                                */
  4477. /****************************************************/
  4478.  
  4479. Call PsnsListFileFilterRule handle, "stemname",
  4480.                             position, "fileFilterName"
  4481.  
  4482.  
  4483. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilterRule - Parameters ΓòÉΓòÉΓòÉ
  4484.  
  4485.  handle 
  4486.            Handle returned by PsnsInit 
  4487.  
  4488.  "stemname" 
  4489.            The name of the stem into which the information is to be put. 
  4490.  
  4491.            Parameter values returned are: 
  4492.  
  4493.                                0drive
  4494.                     The drive letter included / excluded. An asterisk (*) means 
  4495.                     all drives. 
  4496.  
  4497.                                0directory
  4498.                     The directory included / excluded. 
  4499.  
  4500.                                0pattern
  4501.                     Wildcard specifying which files to include / exclude. 
  4502.  
  4503.                                0subdirectories
  4504.                     Possible values are: 
  4505.  
  4506.                     1      Also include / exclude subdirectories in the 
  4507.                            specified directory. 
  4508.                     0      Do not include / exclude subdirectories. 
  4509.  
  4510.                                0include
  4511.                     Possible values are: 
  4512.  
  4513.                     1      Include the specified files. 
  4514.                     0      Exclude the specified files. 
  4515.  
  4516.  position 
  4517.            Number of the rule to be inspected (the first rule is 1). 
  4518.  
  4519.  "fileFilterName" 
  4520.            Name of the file filter to be inspected. 
  4521.  
  4522.  
  4523. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilterRule - Returns ΓòÉΓòÉΓòÉ
  4524.  
  4525.       PSNS_OK 
  4526.       PSNS_HANDLE_IN_USE 
  4527.       PSNS_COMMUNICATIONS_ERROR 
  4528.       PSNS_INVALID_HANDLE 
  4529.       PSNS_INVALID_FILE_FILTER 
  4530.       PSNS_IN_USE 
  4531.       PSNS_INVALID_POSITION 
  4532.       PSNS_INVALID_DRIVE 
  4533.       PSNS_INVALID_PATH 
  4534.       PSNS_INVALID_FILENAME 
  4535.       PSNS_READONLY 
  4536.       PSNS_INVALID_MASK 
  4537.       REXX_INVALID_HANDLE 
  4538.  
  4539.  
  4540. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilterRule - Remarks ΓòÉΓòÉΓòÉ
  4541.  
  4542. Use this function to list the settings for a particular rule within a file 
  4543. filter. The information is returned in the form of compound variables, taking 
  4544. the stemname specified, and a tail added by the program. The compound variables 
  4545. are listed in the parameters section. In order to see how many rules a 
  4546. particular file filter has, use the function PsnsFileFilterInfo. 
  4547.  
  4548. stemname and fileFilterName are in quotes to ensure that their cases are 
  4549. correct. 
  4550.  
  4551.  
  4552. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilterRule - Related functions ΓòÉΓòÉΓòÉ
  4553.  
  4554.      PsnsAddFileFilterRule 
  4555.  
  4556.      PsnsDeleteFileFilterRule 
  4557.  
  4558.      PsnsFileFilterRuleInfo 
  4559.  
  4560.  
  4561. ΓòÉΓòÉΓòÉ 4.53. PsnsListFileFilters ΓòÉΓòÉΓòÉ
  4562.  
  4563. Select an item 
  4564.  
  4565.      Syntax 
  4566.      Parameters 
  4567.      Returns 
  4568.      Remarks 
  4569.      Example 
  4570.      Related functions 
  4571.  
  4572.  
  4573. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilters - Syntax ΓòÉΓòÉΓòÉ
  4574.  
  4575. /***************************************************/
  4576. /* This function lists all the file filters and    */
  4577. /* their current settings                          */
  4578. /***************************************************/
  4579.  
  4580. Call PsnsListFileFilters handle, "stemname", "filename"
  4581.  
  4582.  
  4583. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilters - Parameters ΓòÉΓòÉΓòÉ
  4584.  
  4585.  handle 
  4586.            Handle returned by PsnsInit 
  4587.  
  4588.  "stemname" 
  4589.            The name of the stem into which the information is to be put. 
  4590.  
  4591.            The returned stemname parameter values are preceded by a list 
  4592.            position number for the returned item in the form: 
  4593.  
  4594.                         stemname.n.parameter value
  4595.            where n is the list position number. 
  4596.  
  4597.            The returned stemname parameter values are: 
  4598.  
  4599.                                n.0name
  4600.                     The name of the file filter. 
  4601.  
  4602.                                n.0description
  4603.                     The description of the file filter. 
  4604.  
  4605.                                n.0type
  4606.                     Possible values are: 
  4607.  
  4608.                     TREE     Tree-based filter. 
  4609.                     LIST     Rule-based filter. 
  4610.  
  4611.                     Note:  All the file filters are stored as rule-based 
  4612.                     filters; the type only affects how the file filter is 
  4613.                     displayed when it is edited. 
  4614.  
  4615.                                n.0numRules
  4616.                     The number of rules in the file filter. 
  4617.  
  4618.  "filename" 
  4619.            This parameter is optional. If used, the filename must be fully 
  4620.            qualified; only details of those file filters which would select 
  4621.            this file are listed. 
  4622.  
  4623.  In addition to the returned parameter values given above, the number of items 
  4624.  in the list is returned in: 
  4625.  
  4626.     stemname.0
  4627.  
  4628.  For more information on this topic, see Listing functions 
  4629.  
  4630.  
  4631. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilters - Returns ΓòÉΓòÉΓòÉ
  4632.  
  4633.       PSNS_OK 
  4634.       PSNS_HANDLE_IN_USE 
  4635.       PSNS_COMMUNICATIONS_ERROR 
  4636.       PSNS_INVALID_HANDLE 
  4637.       PSNS_INVALID_LIST_HANDLE 
  4638.       PSNS_NO_MORE_HANDLES 
  4639.       PSNS_INVALID_MASK 
  4640.       REXX_INVALID_HANDLE 
  4641.       REXX_INVALID_PARAMETER 
  4642.  
  4643.  
  4644. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilters - Remarks ΓòÉΓòÉΓòÉ
  4645.  
  4646. Use this function to list all the file filters. The information is returned in 
  4647. the form of compound variables, taking the stemname specified, the number of 
  4648. the list item, and a tail added by the program. The compound variables are 
  4649. listed in the parameters section. 
  4650.  
  4651. "stemname.0", is set to the number of items in the list, so as to ensure that 
  4652. all the list items are looked at. 
  4653.  
  4654. stemname and filename are in quotes to ensure that their cases are correct. 
  4655.  
  4656.  
  4657. ΓòÉΓòÉΓòÉ <hidden> PsnsListFileFilters - Related functions ΓòÉΓòÉΓòÉ
  4658.  
  4659.      PsnsCopyFileFilter 
  4660.  
  4661.      PsnsCreateFileFilter 
  4662.  
  4663.      PsnsDeleteFileFilter 
  4664.  
  4665.      PsnsFileFilterInfo 
  4666.  
  4667.      PsnsRenameFileFilter 
  4668.  
  4669.  
  4670. ΓòÉΓòÉΓòÉ 4.54. PsnsListFiles ΓòÉΓòÉΓòÉ
  4671.  
  4672. Select an item 
  4673.  
  4674.      Syntax 
  4675.      Parameters 
  4676.      Returns 
  4677.      Remarks 
  4678.      Example 
  4679.      Related functions 
  4680.  
  4681.  
  4682. ΓòÉΓòÉΓòÉ <hidden> PsnsListFiles - Syntax ΓòÉΓòÉΓòÉ
  4683.  
  4684. /****************************************************/
  4685. /* This function gives the user the list of files   */
  4686. /* created by calls to PsnsAddFile.                 */
  4687. /****************************************************/
  4688.  
  4689. Call PsnsListFiles handle, "stemname"
  4690.  
  4691.  
  4692. ΓòÉΓòÉΓòÉ <hidden> PsnsListFiles - Parameters ΓòÉΓòÉΓòÉ
  4693.  
  4694.  handle 
  4695.            Handle returned by PsnsInit 
  4696.  
  4697.  "stemname" 
  4698.            The name of the stem into which the information is to be put. 
  4699.  
  4700.            The returned stemname parameter values are preceded by a list 
  4701.            position number for the returned item in the form: 
  4702.  
  4703.                         stemname.n.parameter value
  4704.            where n is the list position number. 
  4705.  
  4706.            The returned stemname parameter values are: 
  4707.  
  4708.                                n.0backupSet
  4709.                     The name of the backup set to which this file is backed up. 
  4710.  
  4711.                                n.0filename
  4712.                     The original name and path of the file. 
  4713.  
  4714.                                n.0generations
  4715.                     The number of generations of this file which are backed up 
  4716.                     to this backup set. 
  4717.  
  4718.                                n.0thisGeneration
  4719.                     The number of the generation to which the information in 
  4720.                     this structure refers. 
  4721.  
  4722.                                n.0creationDay
  4723.                     The day when the file was created. 
  4724.  
  4725.                                n.0creationMonth
  4726.                     The month when the file was created. 
  4727.  
  4728.                                n.0creationYear
  4729.                     The year when the file was created. 
  4730.  
  4731.                                n.0creationHours
  4732.                     The hour of the day when the file was created. 
  4733.  
  4734.                                n.0creationMins
  4735.                     The minute in the hour when the file was created. 
  4736.  
  4737.                                n.0creationSecs
  4738.                     The second in the minute when the file was created. 
  4739.  
  4740.                                n.0writeDay
  4741.                     The day when the backed-up file was last changed. 
  4742.  
  4743.                                n.0writeMonth
  4744.                     The month when the backed-up file was last changed. 
  4745.  
  4746.                                n.0writeYear
  4747.                     The year when the backed-up file was last changed. 
  4748.  
  4749.                                n.0writeHours
  4750.                     The hour of the day when the backed-up file was last 
  4751.                     changed. 
  4752.  
  4753.                                n.0writeMins
  4754.                     The minute in the hour when the backed-up file was last 
  4755.                     changed. 
  4756.  
  4757.                                n.0writeSecs
  4758.                     The second in the minute when the backed-up file was last 
  4759.                     changed. 
  4760.  
  4761.                                n.0backupDay
  4762.                     The day when this generation was backed up. 
  4763.  
  4764.                                n.0backupMonth
  4765.                     The month when this generation was backed up. 
  4766.  
  4767.                                n.0backupYear
  4768.                     The year when this generation was backed up. 
  4769.  
  4770.                                n.0backupHours
  4771.                     The hour of the day when this generation was backed up. 
  4772.  
  4773.                                n.0backupMins
  4774.                     The minute in the hour when this generation was backed up. 
  4775.  
  4776.                                n.0backupSecs
  4777.                     The second in the minute when this generation was backed 
  4778.                     up. 
  4779.  
  4780.                                n.0size
  4781.                     The size of the file. 
  4782.  
  4783.                                n.0attribs
  4784.                     The file attributes in the form returned by 
  4785.                     DosQueryFileInfo. 
  4786.  
  4787.                                n.0volumeID
  4788.                     The ID of the volume on which this generation is stored. 
  4789.  
  4790.  In addition to the returned parameter values given above, the number of items 
  4791.  in the list is returned in: 
  4792.  
  4793.     stemname.0
  4794.  
  4795.  For more information on this topic, see Listing functions 
  4796.  
  4797.  
  4798. ΓòÉΓòÉΓòÉ <hidden> PsnsListFiles - Returns ΓòÉΓòÉΓòÉ
  4799.  
  4800.       PSNS_OK 
  4801.       PSNS_HANDLE_IN_USE 
  4802.       PSNS_COMMUNICATIONS_ERROR 
  4803.       PSNS_INVALID_HANDLE 
  4804.       PSNS_INVALID_LIST_HANDLE 
  4805.       PSNS_NO_MORE_HANDLES 
  4806.       PSNS_INVALID_MASK 
  4807.       PSNS_INVALID_BACKUP_SET 
  4808.       PSNS_ARCHIVE_ERROR 
  4809.       PSNS_TRANSFERRED_OUT 
  4810.       REXX_INVALID_HANDLE 
  4811.  
  4812.  
  4813. ΓòÉΓòÉΓòÉ <hidden> PsnsListFiles - Remarks ΓòÉΓòÉΓòÉ
  4814.  
  4815. Use this function to list files which have been backed up to a backup set. The 
  4816. information is returned in the form of compound variables, taking the stemname 
  4817. specified, the number of the list item, and a tail added by the program. The 
  4818. compound variables are listed in the parameters section. 
  4819.  
  4820. "stemname.0", is set to the number of items in the list, so as to ensure that 
  4821. all the list items are looked at. 
  4822.  
  4823. stemname is in quotes to ensure that its case is correct. 
  4824.  
  4825.  
  4826. ΓòÉΓòÉΓòÉ <hidden> PsnsListFiles - Related functions ΓòÉΓòÉΓòÉ
  4827.  
  4828.      PsnsAddFile 
  4829.  
  4830.      PsnsBackupFiles 
  4831.  
  4832.      PsnsDropFiles 
  4833.  
  4834.      PsnsPurgeFiles 
  4835.  
  4836.      PsnsRestoreFiles 
  4837.  
  4838.  
  4839. ΓòÉΓòÉΓòÉ 4.55. PsnsListRestoreMethods ΓòÉΓòÉΓòÉ
  4840.  
  4841. Select an item 
  4842.  
  4843.      Syntax 
  4844.      Parameters 
  4845.      Returns 
  4846.      Remarks 
  4847.      Example 
  4848.      Related functions 
  4849.  
  4850.  
  4851. ΓòÉΓòÉΓòÉ <hidden> PsnsListRestoreMethods - Syntax ΓòÉΓòÉΓòÉ
  4852.  
  4853. /***************************************************/
  4854. /* This function lists all the restore methods and */
  4855. /* their current settings                          */
  4856. /***************************************************/
  4857.  
  4858. Call PsnsListRestoreMethods handle, "stemname"
  4859.  
  4860.  
  4861. ΓòÉΓòÉΓòÉ <hidden> PsnsListRestoreMethods - Parameters ΓòÉΓòÉΓòÉ
  4862.  
  4863.  handle 
  4864.            Handle returned by PsnsInit 
  4865.  
  4866.  "stemname" 
  4867.            The name of the stem into which the information is to be put. 
  4868.  
  4869.            The returned stemname parameter values are preceded by a list 
  4870.            position number for the returned item in the form: 
  4871.  
  4872.                         stemname.n.parameter value
  4873.            where n is the list position number. 
  4874.  
  4875.            The returned stemname parameter values are: 
  4876.  
  4877.                                n.0name
  4878.                     The name of the restore method. 
  4879.  
  4880.                                n.0description
  4881.                     The description of the restore method 
  4882.  
  4883.                                n.0backupSet
  4884.                     This can be any one of the following: 
  4885.  
  4886.                          The name of the backup set from which the restore is 
  4887.                          to be made 
  4888.  
  4889.                          An asterisk (*) to restore from all backup sets 
  4890.  
  4891.                          A zero length string (defined by two consecutive 
  4892.                          single or double quotation marks) to restore from the 
  4893.                          default backup set. 
  4894.  
  4895.                                n.0allFiles
  4896.                     Possible values are: 
  4897.  
  4898.                     1      Restore all files in the backup set; the drive, 
  4899.                            directory and subdirectories fields are ignored. 
  4900.                     0      Allow the backup of files specified by the drive, 
  4901.                            directory and subdirectories fields. 
  4902.  
  4903.                                n.0drive
  4904.                     Original drive of the files to be restored. 
  4905.  
  4906.                                n.0directory
  4907.                     Original directory of the files to be restored. 
  4908.  
  4909.                                n.0pattern
  4910.                     Wildcard selecting which files are to be restored. 
  4911.  
  4912.                                n.0subdirectories
  4913.                     Possible values are: 
  4914.  
  4915.                     1      Restore files in subdirectories of the selected 
  4916.                            directories. 
  4917.                     0      Do not restore files in subdirectories. 
  4918.  
  4919.                                n.0byDate
  4920.                     Possible values are: 
  4921.  
  4922.                     1      Restore files as they were on the date specified in 
  4923.                            date and time. 
  4924.                     0      Restore the most recent generation of each file. 
  4925.  
  4926.                                n.0date
  4927.                     Files will be restored to the state they were in on this 
  4928.                     date if byDate is set to 1. 
  4929.  
  4930.                                n.0time
  4931.                     Files will be restored to the state they were in at this 
  4932.                     time if byDate is set to 1. 
  4933.  
  4934.                                n.0preview
  4935.                     Possible values are: 
  4936.  
  4937.                     1      A preview is shown before the restore which allows 
  4938.                            the user to select or deselect individual files. 
  4939.                     0      A preview is not shown before the restore. 
  4940.  
  4941.                     Note:  Showing a preview is only useful if the restore 
  4942.                     method is to be run from the OS/2 Warp Server 
  4943.                     Backup/Restore window; it is not possible to show a preview 
  4944.                     when running a restore method using the API. 
  4945.  
  4946.            n.0prompt 
  4947.  
  4948.                     1      The user is prompted to select a generation of each 
  4949.                            file to be restored. 
  4950.                     0      The user is not prompted; the most recent generation 
  4951.                            of each file is restored. 
  4952.  
  4953.                     Note:  This is only useful if the restore method is to be 
  4954.                     run from the OS/2 Warp Server Backup/Restore window; it is 
  4955.                     not possible to pick generations when running a restore 
  4956.                     method using the API. 
  4957.  
  4958.                                n.0originalLocation
  4959.                     Possible values are: 
  4960.  
  4961.                     1      Restore files to their original locations; 
  4962.                            destinationDrive and destinationPath are ignored. 
  4963.                     0      Restore files to the drive and path specified in 
  4964.                            destinationDrive and destinationPath. 
  4965.  
  4966.                                n.0destinationDrive
  4967.                     Drive to which to restore files if originalLocation is set 
  4968.                     to 0. 
  4969.  
  4970.                                n.0destinationPath
  4971.                     Path to which to restore files if originalLocation is set 
  4972.                     to 0. 
  4973.  
  4974.  In addition to the returned parameter values given above, the number of items 
  4975.  in the list is returned in: 
  4976.  
  4977.     stemname.0
  4978.  
  4979.  For more information on this topic, see Listing functions 
  4980.  
  4981.  
  4982. ΓòÉΓòÉΓòÉ <hidden> PsnsListRestoreMethods - Returns ΓòÉΓòÉΓòÉ
  4983.  
  4984.       PSNS_OK 
  4985.       PSNS_HANDLE_IN_USE 
  4986.       PSNS_COMMUNICATIONS_ERROR 
  4987.       PSNS_INVALID_HANDLE 
  4988.       PSNS_INVALID_LIST_HANDLE 
  4989.       PSNS_NO_MORE_HANDLES 
  4990.       PSNS_INVALID_MASK 
  4991.       REXX_INVALID_HANDLE 
  4992.  
  4993.  
  4994. ΓòÉΓòÉΓòÉ <hidden> PsnsListRestoreMethods - Remarks ΓòÉΓòÉΓòÉ
  4995.  
  4996. Use this function to list all the restore methods. The information is returned 
  4997. in terms of compound variables, taking the stemname specified, the number of 
  4998. the list item, and a tail added by the program. The compound variables are 
  4999. listed in the parameters section. 
  5000.  
  5001. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5002. all the list items are looked at. 
  5003.  
  5004. stemname is in quotes to ensure that its case is correct. 
  5005.  
  5006.  
  5007. ΓòÉΓòÉΓòÉ <hidden> PsnsListRestoreMethods - Related functions ΓòÉΓòÉΓòÉ
  5008.  
  5009.      PsnsCopyRestoreMethod 
  5010.  
  5011.      PsnsCreateRestoreMethod 
  5012.  
  5013.      PsnsDeleteRestoreMethod 
  5014.  
  5015.      PsnsEstimateRestoreMethod 
  5016.  
  5017.      PsnsRenameRestoreMethod 
  5018.  
  5019.      PsnsRestoreMethodInfo 
  5020.  
  5021.      PsnsRunRestoreMethod 
  5022.  
  5023.  
  5024. ΓòÉΓòÉΓòÉ 4.56. PsnsListRulebookRule ΓòÉΓòÉΓòÉ
  5025.  
  5026. Select an item 
  5027.  
  5028.      Syntax 
  5029.      Parameters 
  5030.      Returns 
  5031.      Remarks 
  5032.      Example 
  5033.      Related functions 
  5034.  
  5035.  
  5036. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebookRule - Syntax ΓòÉΓòÉΓòÉ
  5037.  
  5038. /****************************************************/
  5039. /* This function lists the settings for a given     */
  5040. /* file filter rule.                                */
  5041. /****************************************************/
  5042.  
  5043. Call PsnsListRulebookRule handle, "stemname",
  5044.                           position, "rulebookName"
  5045.  
  5046.  
  5047. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebookRule - Parameters ΓòÉΓòÉΓòÉ
  5048.  
  5049.  handle 
  5050.            Handle returned by PsnsInit 
  5051.  
  5052.  "stemname" 
  5053.            The name of the stem into which the information is to be put. 
  5054.  
  5055.            Parameter values returned are: 
  5056.  
  5057.                                0drive
  5058.                     The drive letter included / excluded. An asterisk (*) means 
  5059.                     all drives. 
  5060.  
  5061.                                0directory
  5062.                     The directory included / excluded. 
  5063.  
  5064.                                0pattern
  5065.                     Wildcard specifying which files to be included / excluded. 
  5066.  
  5067.                                0subdirectories
  5068.                     Possible values are: 
  5069.  
  5070.                     1      Also include / exclude subdirectories in the 
  5071.                            specified directory. 
  5072.                     0      Do not include / exclude subdirectories. 
  5073.  
  5074.                                0generations
  5075.                     Number of generations to keep of specified files. 
  5076.  
  5077.                                0compression
  5078.                     Possible values are: 
  5079.  
  5080.                     NOCOMPRESSION       Compress the specified files. 
  5081.                     COMPRESSION         Do not compress the specified files. 
  5082.                     DEFAULT             Use the default compression for the 
  5083.                                         specified files. 
  5084.  
  5085.  "rulebookName" 
  5086.            Name of the rulebook to which the rule is to be added. 
  5087.  
  5088.  position 
  5089.            This specifies the position where the rule is to be added to the 
  5090.            file filter; 1 means add at the beginning, 2 after the first rule 
  5091.            and so on. 
  5092.  
  5093.  
  5094. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebookRule - Returns ΓòÉΓòÉΓòÉ
  5095.  
  5096.       PSNS_OK 
  5097.       PSNS_HANDLE_IN_USE 
  5098.       PSNS_COMMUNICATIONS_ERROR 
  5099.       PSNS_INVALID_HANDLE 
  5100.       PSNS_INVALID_RULEBOOK 
  5101.       PSNS_IN_USE 
  5102.       PSNS_INVALID_POSITION 
  5103.       PSNS_INVALID_DRIVE 
  5104.       PSNS_INVALID_PATH 
  5105.       PSNS_INVALID_FILENAME 
  5106.       PSNS_INVALID_COMPRESSION 
  5107.       PSNS_INVALID_GENERATIONS 
  5108.       PSNS_READONLY 
  5109.       PSNS_INVALID_MASK 
  5110.       REXX_INVALID_HANDLE 
  5111.       REXX_INVALID_PARAMETER 
  5112.  
  5113.  
  5114. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebookRule - Remarks ΓòÉΓòÉΓòÉ
  5115.  
  5116. Use this function to list the settings for a particular rule within a rulebook. 
  5117. The information is returned in terms of compound variables, taking the stemname 
  5118. specified, and a tail added by the program. The compound variables are listed 
  5119. in the parameters section. 
  5120.  
  5121. In order to see how many rules a particular rulebook has, use the function 
  5122. PsnsRulebookInfo. 
  5123.  
  5124. stemname and rulebookName are in quotes to ensure that their cases are correct. 
  5125.  
  5126.  
  5127. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebookRule - Related functions ΓòÉΓòÉΓòÉ
  5128.  
  5129.      PsnsAddRulebookRule 
  5130.  
  5131.      PsnsDeleteRulebookRule 
  5132.  
  5133.      PsnsRulebookRuleInfo 
  5134.  
  5135.  
  5136. ΓòÉΓòÉΓòÉ 4.57. PsnsListRulebooks ΓòÉΓòÉΓòÉ
  5137.  
  5138. Select an item 
  5139.  
  5140.      Syntax 
  5141.      Parameters 
  5142.      Returns 
  5143.      Remarks 
  5144.      Example 
  5145.      Related functions 
  5146.  
  5147.  
  5148. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebooks - Syntax ΓòÉΓòÉΓòÉ
  5149.  
  5150. /***************************************************/
  5151. /* This function lists all the rulebooks and       */
  5152. /* their current settings                          */
  5153. /***************************************************/
  5154.  
  5155. Call PsnsListRulebooks handle, "stemname"
  5156.  
  5157.  
  5158. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebooks - Parameters ΓòÉΓòÉΓòÉ
  5159.  
  5160.  handle 
  5161.            Handle returned by PsnsInit 
  5162.  
  5163.  "stemname" 
  5164.            The name of the stem into which the information is to be put. 
  5165.  
  5166.            The returned stemname parameter values are preceded by a list 
  5167.            position number for the returned item in the form: 
  5168.  
  5169.                         stemname.n.parameter value
  5170.            where n is the list position number. 
  5171.  
  5172.            The returned stemname parameter values are: 
  5173.  
  5174.                                n.0name
  5175.                     The name of the rulebook. 
  5176.  
  5177.                                n.0description
  5178.                     The description of the rulebook. 
  5179.  
  5180.                                n.0numRules
  5181.                     The number of rules in the rulebook. 
  5182.  
  5183.  In addition to the returned parameter values given above, the number of items 
  5184.  in the list is returned in: 
  5185.  
  5186.     stemname.0
  5187.  
  5188.  For more information on this topic, see Listing functions 
  5189.  
  5190.  
  5191. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebooks - Returns ΓòÉΓòÉΓòÉ
  5192.  
  5193.       PSNS_OK 
  5194.       PSNS_HANDLE_IN_USE 
  5195.       PSNS_COMMUNICATIONS_ERROR 
  5196.       PSNS_INVALID_HANDLE 
  5197.       PSNS_INVALID_LIST_HANDLE 
  5198.       PSNS_NO_MORE_HANDLES 
  5199.       PSNS_INVALID_MASK 
  5200.       REXX_INVALID_HANDLE 
  5201.  
  5202.  
  5203. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebooks - Remarks ΓòÉΓòÉΓòÉ
  5204.  
  5205. Use this function to list all the rulebooks. The information is returned in 
  5206. terms of compound variables, taking the stemname specified, the number of the 
  5207. list item, and a tail added by the program. The compound variables are listed 
  5208. in the parameters section. 
  5209.  
  5210. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5211. all the list items are looked at. 
  5212.  
  5213. stemname is in quotes to ensure that its case is correct. 
  5214.  
  5215.  
  5216. ΓòÉΓòÉΓòÉ <hidden> PsnsListRulebooks - Related functions ΓòÉΓòÉΓòÉ
  5217.  
  5218.      PsnsCopyRulebook 
  5219.  
  5220.      PsnsCreateRulebook 
  5221.  
  5222.      PsnsDeleteRulebook 
  5223.  
  5224.      PsnsRenameRulebook 
  5225.  
  5226.      PsnsRulebookInfo 
  5227.  
  5228.  
  5229. ΓòÉΓòÉΓòÉ 4.58. PsnsListSettings ΓòÉΓòÉΓòÉ
  5230.  
  5231. Select an item 
  5232.  
  5233.      Syntax 
  5234.      Parameters 
  5235.      Returns 
  5236.      Remarks 
  5237.      Example 
  5238.      Related functions 
  5239.  
  5240.  
  5241. ΓòÉΓòÉΓòÉ <hidden> PsnsListSettings - Syntax ΓòÉΓòÉΓòÉ
  5242.  
  5243. /****************************************************/
  5244. /* This function lists many of the general options. */
  5245. /****************************************************/
  5246.  
  5247. Call PsnsListSettings handle, "stemname"
  5248.  
  5249.  
  5250. ΓòÉΓòÉΓòÉ <hidden> PsnsListSettings - Parameters ΓòÉΓòÉΓòÉ
  5251.  
  5252.  handle 
  5253.            Handle returned by PsnsInit 
  5254.  
  5255.  "stemname" 
  5256.            The name of the stem into which the information is to be put. 
  5257.  
  5258.            Parameter values returned are: 
  5259.  
  5260.                                0manualPriority
  5261.                     Possible values are: 
  5262.  
  5263.                     1      Normal priority for manual backups. 
  5264.                     2      High priority for manual backups. 
  5265.  
  5266.                                0autoPriority
  5267.                     Possible values are: 
  5268.  
  5269.                     1      Normal priority for automatic backups. 
  5270.                     2      High priority for automatic backups. 
  5271.  
  5272.                                0tempPath
  5273.                     Path for temporary files. 
  5274.  
  5275.                                0flags
  5276.                     A binary string representing the following on/off flags: 
  5277.  
  5278.                     SET_LOG 
  5279.                              Enable logging for backup, restore and drop 
  5280.                              activities. 
  5281.                     SET_LOG_SUCCESSES 
  5282.                              Log individual files which are successful. 
  5283.                     SET_LOG_FAILURES 
  5284.                              Log individual files which fail. 
  5285.                     SET_BACKUP_EXIT 
  5286.                              Enable the user exit on backup. 
  5287.                     SET_RESTORE_EXIT 
  5288.                              Enable the user exit on restore. 
  5289.  
  5290.                     Note:  The first flag, SET_LOG, is represented by the least 
  5291.                     significant bit of the string (the right-most digit 00001); 
  5292.                     the second flag, SET_LOG_SUCCESSES, is represented by the 
  5293.                     next least significant bit of the string (the second digit 
  5294.                     from the right 00010), and so on. A bit set to one 
  5295.                     indicates the flag is set to true, a bit set to zero 
  5296.                     indicates false. 
  5297.  
  5298.                                0logFileLimit
  5299.                     Maximum number of lines in a log file. If this is 0 (zero) 
  5300.                     then there is no limit to the size of a log file. 
  5301.  
  5302.                                0backupExit
  5303.                     The name of a REXX command file to run on backup. 
  5304.  
  5305.                                0restoreExit
  5306.                     The name of a REXX command file to run on restore. 
  5307.  
  5308.                                0enableACLBackup
  5309.                     Possible values are: 
  5310.  
  5311.                     1      Back up and restore Access Control Lists using 
  5312.                            BACKACC and RESTACC. 
  5313.                     0      Do not back up and restore Access Control Lists. 
  5314.  
  5315.                                0uadFilename
  5316.                     The name of the file which contains the User Accounts 
  5317.                     Database, usually NET.ACC. For more information on REXX 
  5318.                     user exits and on backing up Access Control Lists, see the 
  5319.                     OS/2 Warp Server Backup/Restore online help. 
  5320.  
  5321.  
  5322. ΓòÉΓòÉΓòÉ <hidden> PsnsListSettings - Returns ΓòÉΓòÉΓòÉ
  5323.  
  5324.       PSNS_OK 
  5325.       PSNS_HANDLE_IN_USE 
  5326.       PSNS_COMMUNICATIONS_ERROR 
  5327.       PSNS_INVALID_HANDLE 
  5328.       PSNS_INVALID_PRIORITY 
  5329.       PSNS_INVALID_PATH 
  5330.       PSNS_INVALID_FLAGS 
  5331.       PSNS_INVALID_MASK 
  5332.       REXX_INVALID_HANDLE 
  5333.  
  5334.  
  5335. ΓòÉΓòÉΓòÉ <hidden> PsnsListSettings - Remarks ΓòÉΓòÉΓòÉ
  5336.  
  5337. Use this function to inspect the following settings: 
  5338.  
  5339.      Priority of backup and restore threads 
  5340.      Path for temporary files 
  5341.      Log file options 
  5342.      User exits 
  5343.  
  5344.  The information is returned in terms of compound variables, taking the 
  5345.  stemname specified, and a tail added by the program. The compound variables 
  5346.  are listed in the parameters section. 
  5347.  
  5348.  To change the settings, use PsnsSettingsInfo. 
  5349.  
  5350.  stemname is in quotes to ensure that its case is correct. 
  5351.  
  5352.  
  5353. ΓòÉΓòÉΓòÉ <hidden> PsnsListSettings - Related functions ΓòÉΓòÉΓòÉ
  5354.  
  5355.      PsnsDefaultsInfo 
  5356.  
  5357.      PsnsListDefaults 
  5358.  
  5359.      PsnsSettingsInfo 
  5360.  
  5361.  
  5362. ΓòÉΓòÉΓòÉ 4.59. PsnsListSourceDrives ΓòÉΓòÉΓòÉ
  5363.  
  5364. Select an item 
  5365.  
  5366.      Syntax 
  5367.      Parameters 
  5368.      Returns 
  5369.      Remarks 
  5370.      Example 
  5371.      Related functions 
  5372.  
  5373.  
  5374. ΓòÉΓòÉΓòÉ <hidden> PsnsListSourceDrives - Syntax ΓòÉΓòÉΓòÉ
  5375.  
  5376. /****************************************************/
  5377. /* This function lists all the source drives        */
  5378. /****************************************************/
  5379.  
  5380. Call PsnsListSourceDrives handle, "stemname"
  5381.  
  5382.  
  5383. ΓòÉΓòÉΓòÉ <hidden> PsnsListSourceDrives - Parameters ΓòÉΓòÉΓòÉ
  5384.  
  5385.  handle 
  5386.            Handle returned by PsnsInit 
  5387.  
  5388.  "stemname" 
  5389.            The name of the stem into which the information is to be put. 
  5390.  
  5391.            The returned stemname parameter values are preceded by a list 
  5392.            position number for the returned item in the form: 
  5393.  
  5394.                         stemname.n.parameter value
  5395.            where n is the list position number. 
  5396.  
  5397.            The returned stemname parameter values are: 
  5398.  
  5399.                                n.0driveLetter
  5400.                     The drive letter of the source drive. 
  5401.  
  5402.                                n.0type
  5403.                     The type of the source drive. Possible values are: 
  5404.  
  5405.                      HARDDISK     A hard disk drive. 
  5406.                      DISKETTE     A floppy disk drive. 
  5407.                      LANDRIVE     A lan drive. 
  5408.                      OPTICAL      A read-write optical drive. 
  5409.                      CDROM        A CD-Rom drive. 
  5410.                      REMOVABLE    A removable drive. 
  5411.                      OTHER        Some other type of drive. 
  5412.  
  5413.                                n.0selected
  5414.                     Possible values are: 
  5415.  
  5416.                     1      This drive will be checked for files to back up. 
  5417.                     0      This drive will not be checked for files to back up. 
  5418.  
  5419.  In addition to the returned parameter values given above, the number of items 
  5420.  in the list is returned in: 
  5421.  
  5422.     stemname.0
  5423.  
  5424.  For more information on this topic, see Listing functions 
  5425.  
  5426.  
  5427. ΓòÉΓòÉΓòÉ <hidden> PsnsListSourceDrives - Returns ΓòÉΓòÉΓòÉ
  5428.  
  5429.       PSNS_OK 
  5430.       PSNS_HANDLE_IN_USE 
  5431.       PSNS_COMMUNICATIONS_ERROR 
  5432.       PSNS_INVALID_HANDLE 
  5433.       PSNS_INVALID_LIST_HANDLE 
  5434.       PSNS_NO_MORE_HANDLES 
  5435.       PSNS_INVALID_MASK 
  5436.       REXX_INVALID_HANDLE 
  5437.       REXX_INVALID_PARAMETER 
  5438.  
  5439.  
  5440. ΓòÉΓòÉΓòÉ <hidden> PsnsListSourceDrives - Remarks ΓòÉΓòÉΓòÉ
  5441.  
  5442. Use this function to list all the source drives. The information is returned in 
  5443. terms of compound variables, taking the stemname specified, the number of the 
  5444. list item, and a tail added by the program. The compound variables are listed 
  5445. in the parameters section. 
  5446.  
  5447. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5448. all the list items are looked at. 
  5449.  
  5450. stemname is in quotes to ensure that its case is correct. 
  5451.  
  5452.  
  5453. ΓòÉΓòÉΓòÉ <hidden> PsnsListSourceDrives - Related functions ΓòÉΓòÉΓòÉ
  5454.  
  5455.      PsnsRefreshSourceDrives 
  5456.  
  5457.      PsnsSelectSourceDrive 
  5458.  
  5459.      PsnsSourceDriveType 
  5460.  
  5461.  
  5462. ΓòÉΓòÉΓòÉ 4.60. PsnsListStorageDevices ΓòÉΓòÉΓòÉ
  5463.  
  5464. Select an item 
  5465.  
  5466.      Syntax 
  5467.      Parameters 
  5468.      Returns 
  5469.      Remarks 
  5470.      Example 
  5471.      Related functions 
  5472.  
  5473.  
  5474. ΓòÉΓòÉΓòÉ <hidden> PsnsListStorageDevices - Syntax ΓòÉΓòÉΓòÉ
  5475.  
  5476. /****************************************************/
  5477. /* This function lists all the storage devices      */
  5478. /****************************************************/
  5479.  
  5480. Call PsnsListStorageDevices handle, "stemname"
  5481.  
  5482.  
  5483. ΓòÉΓòÉΓòÉ <hidden> PsnsListStorageDevices - Parameters ΓòÉΓòÉΓòÉ
  5484.  
  5485.  handle 
  5486.            Handle returned by PsnsInit 
  5487.  
  5488.  "stemname" 
  5489.            The name of the stem into which the information is to be put. 
  5490.  
  5491.            The returned stemname parameter values are preceded by a list 
  5492.            position number for the returned item in the form: 
  5493.  
  5494.                         stemname.n.parameter value
  5495.            where n is the list position number. 
  5496.  
  5497.            The returned stemname parameter values are: 
  5498.  
  5499.                                n.0name
  5500.                     The name of the storage device. 
  5501.  
  5502.                                n.0dllName
  5503.                     The name of the Dynamic Link Library (DLL) which implements 
  5504.                     the storage device. 
  5505.  
  5506.  In addition to the returned parameter values given above, the number of items 
  5507.  in the list is returned in: 
  5508.  
  5509.     stemname.0
  5510.  
  5511.  For more information on this topic, see Listing functions 
  5512.  
  5513.  
  5514. ΓòÉΓòÉΓòÉ <hidden> PsnsListStorageDevices - Returns ΓòÉΓòÉΓòÉ
  5515.  
  5516.       PSNS_OK 
  5517.       PSNS_HANDLE_IN_USE 
  5518.       PSNS_COMMUNICATIONS_ERROR 
  5519.       PSNS_INVALID_HANDLE 
  5520.       PSNS_INVALID_LIST_HANDLE 
  5521.       PSNS_NO_MORE_HANDLES 
  5522.       PSNS_INVALID_MASK 
  5523.       REXX_INVALID_HANDLE 
  5524.  
  5525.  
  5526. ΓòÉΓòÉΓòÉ <hidden> PsnsListStorageDevices - Remarks ΓòÉΓòÉΓòÉ
  5527.  
  5528. Use this function to list all the storage devices. The information is returned 
  5529. in terms of compound variables, taking the stemname specified, the number of 
  5530. the list item, and a tail added by the program. The compound variables are 
  5531. listed in the parameters section. 
  5532.  
  5533. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5534. all the list items are looked at. 
  5535.  
  5536. stemname is in quotes to ensure that its case is correct. 
  5537.  
  5538.  
  5539. ΓòÉΓòÉΓòÉ <hidden> PsnsListStorageDevices - Related functions ΓòÉΓòÉΓòÉ
  5540.  
  5541.      PsnsCreateStorageDevice 
  5542.  
  5543.      PsnsDeleteStorageDevice 
  5544.  
  5545.      PsnsGetStorageDeviceConfig 
  5546.  
  5547.      PsnsListCreatableStorageDevices 
  5548.  
  5549.      PsnsRefreshStorageDevices 
  5550.  
  5551.      PsnsSetStorageDeviceConfig 
  5552.  
  5553.      PsnsStorageDeviceInfo 
  5554.  
  5555.  
  5556. ΓòÉΓòÉΓòÉ 4.61. PsnsListVolumeBackupSets ΓòÉΓòÉΓòÉ
  5557.  
  5558. Select an item 
  5559.  
  5560.      Syntax 
  5561.      Parameters 
  5562.      Returns 
  5563.      Remarks 
  5564.      Example 
  5565.      Related functions 
  5566.  
  5567.  
  5568. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumeBackupSets - Syntax ΓòÉΓòÉΓòÉ
  5569.  
  5570. /***************************************************/
  5571. /* This function lists backup sets on a given      */
  5572. /* volume or storage device                        */
  5573. /***************************************************/
  5574.  
  5575. Call PsnsListVolumeBackupSets handle, "stemname",
  5576.                               volumeID, "storageDevice"
  5577.  
  5578.  
  5579. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumeBackupSets - Parameters ΓòÉΓòÉΓòÉ
  5580.  
  5581.  handle 
  5582.            Handle returned by PsnsInit 
  5583.  
  5584.  "stemname" 
  5585.            The name of the stem into which the information is to be put. 
  5586.  
  5587.            The returned stemname parameter values are preceded by a list 
  5588.            position number for the returned item in the form: 
  5589.  
  5590.                         stemname.n.parameter value
  5591.            where n is the list position number. 
  5592.  
  5593.            The returned stemname parameter values are: 
  5594.  
  5595.                                n.0backupSet
  5596.                     The name of the backup set 
  5597.  
  5598.                                n.0spaceUsed
  5599.                     Space taken up on the volume by this backup set in units of 
  5600.                     unitMultiplier 
  5601.  
  5602.  volumeID 
  5603.            The ID of the volume for which a list of backup sets is required. 
  5604.  
  5605.  storageDevice 
  5606.            An optional parameter specifying a storage device. If this parameter 
  5607.            is specified, then volumeID should be set to zero. 
  5608.  
  5609.  In addition to the returned parameter values given above, the number of items 
  5610.  in the list is returned in: 
  5611.  
  5612.     stemname.0
  5613.  
  5614.  For more information on this topic, see Listing functions 
  5615.  
  5616.  
  5617. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumeBackupSets - Returns ΓòÉΓòÉΓòÉ
  5618.  
  5619.       PSNS_OK 
  5620.       PSNS_HANDLE_IN_USE 
  5621.       PSNS_COMMUNICATIONS_ERROR 
  5622.       PSNS_INVALID_HANDLE 
  5623.       PSNS_INVALID_LIST_HANDLE 
  5624.       PSNS_NO_MORE_HANDLES 
  5625.       PSNS_INVALID_MASK 
  5626.       PSNS_INVALID_VOLUME 
  5627.       REXX_INVALID_HANDLE 
  5628.  
  5629.  
  5630. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumeBackupSets - Remarks ΓòÉΓòÉΓòÉ
  5631.  
  5632. Use this function to view the backup sets present on a specific volume. If the 
  5633. optional storageDevice parameter is filled in, then OS/2 Warp Server 
  5634. Backup/Restore will look at the volume in the storage device and generate a 
  5635. list of backup sets that are on the storage device. 
  5636.  
  5637. The information is returned in terms of compound variables, taking the stemname 
  5638. specified, the number of the list item, and a tail added by the program. The 
  5639. compound variables are listed in the parameters section. 
  5640.  
  5641. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5642. all the list items are looked at. 
  5643.  
  5644. stemname is in quotes to ensure that its case is correct. 
  5645.  
  5646.  
  5647. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumeBackupSets - Related functions ΓòÉΓòÉΓòÉ
  5648.  
  5649.      PsnsListVolumes 
  5650.  
  5651.  
  5652. ΓòÉΓòÉΓòÉ 4.62. PsnsListVolumes ΓòÉΓòÉΓòÉ
  5653.  
  5654. Select an item 
  5655.  
  5656.      Syntax 
  5657.      Parameters 
  5658.      Returns 
  5659.      Remarks 
  5660.      Example 
  5661.      Related functions 
  5662.  
  5663.  
  5664. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumes - Syntax ΓòÉΓòÉΓòÉ
  5665.  
  5666. /***************************************************/
  5667. /* This function lists all the volumes             */
  5668. /***************************************************/
  5669.  
  5670. Call PsnsListVolumes handle, "stemname"
  5671.  
  5672.  
  5673. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumes - Parameters ΓòÉΓòÉΓòÉ
  5674.  
  5675.  handle 
  5676.            Handle returned by PsnsInit 
  5677.  
  5678.  "stemname" 
  5679.            The name of the stem into which the information is to be put. 
  5680.  
  5681.            The returned stemname parameter values are preceded by a list 
  5682.            position number for the returned item in the form: 
  5683.  
  5684.                         stemname.n.parameter value
  5685.            where n is the list position number. 
  5686.  
  5687.            The returned stemname parameter values are: 
  5688.  
  5689.                                n.0id
  5690.                     The volume ID 
  5691.  
  5692.                                n.0name
  5693.                     The name of the volume 
  5694.  
  5695.                                n.0storageDevice
  5696.                     The storage device it uses 
  5697.  
  5698.                                n.0transferredOut
  5699.                     Possible values are: 
  5700.  
  5701.                     1      The volume belongs to a backup set that has been 
  5702.                            transferred out 
  5703.                     0      The volume belongs to a backup set that has not been 
  5704.                            transferred out 
  5705.  
  5706.                                n.0available
  5707.                     Possible values are: 
  5708.  
  5709.                     1      The volume is available for use. 
  5710.                     0      The user has made the volume unavailable and it will 
  5711.                            not be used for backing up or restoring data. 
  5712.  
  5713.                                n.0backupSets
  5714.                     The number of backup sets which use this volume 
  5715.  
  5716.                                n.0unitMultiplier
  5717.                     This specifies the units in which the volume usage 
  5718.                     information is specified. It is a number in bytes, for 
  5719.                     example, 1024 for kilobytes. 
  5720.  
  5721.                                n.0totalCapacity
  5722.                     Total size of the volume in units of unitMultiplier 
  5723.  
  5724.                                n.0psnsCapacity
  5725.                     Amount of space on the volume, in units of unitMultiplier, 
  5726.                     which is available for OS/2 Warp Server Backup/Restore to 
  5727.                     use, 
  5728.  
  5729.                                n.0psnsUsed
  5730.                     Amount of space currently used on the volume by OS/2 Warp 
  5731.                     Server Backup/Restore, in units of unitMultiplier 
  5732.  
  5733.                                n.0psnsFree
  5734.                     Amount of free space on the volume, in units of 
  5735.                     unitMultiplier, which OS/2 Warp Server Backup/Restore may 
  5736.                     use. 
  5737.  
  5738.                                n.0otherFree
  5739.                     Amount of free space on the volume, in units of 
  5740.                     unitMultiplier, which OS/2 Warp Server Backup/Restore may 
  5741.                     not use. 
  5742.  
  5743.                                n.0totalBad
  5744.                     Total amount of unusable space on the volume, in units of 
  5745.                     unitMultiplier 
  5746.  
  5747.                                n.0backupSet
  5748.                     If the volume is used for only one backup set, this 
  5749.                     contains the name of that backup set. 
  5750.  
  5751.                                n.0indexNo
  5752.                     If the volume is used for only one backup set, this 
  5753.                     contains the index of the volume within the backup set. A 
  5754.                     negative value signifies that the volume is an index 
  5755.                     diskette. A value of zero means that the volume is 
  5756.                     unassociated or fixed. 
  5757.  
  5758.  In addition to the returned parameter values given above, the number of items 
  5759.  in the list is returned in: 
  5760.  
  5761.     stemname.0
  5762.  
  5763.  For more information on this topic, see Listing functions 
  5764.  
  5765.  
  5766. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumes - Returns ΓòÉΓòÉΓòÉ
  5767.  
  5768.       PSNS_OK 
  5769.       PSNS_HANDLE_IN_USE 
  5770.       PSNS_COMMUNICATIONS_ERROR 
  5771.       PSNS_INVALID_HANDLE 
  5772.       PSNS_INVALID_LIST_HANDLE 
  5773.       PSNS_NO_MORE_HANDLES 
  5774.       PSNS_INVALID_MASK 
  5775.       REXX_INVALID_HANDLE 
  5776.  
  5777.  
  5778. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumes - Remarks ΓòÉΓòÉΓòÉ
  5779.  
  5780. Use this function to view the information on all the volumes. The information 
  5781. is returned in terms of compound variables, taking the stemname specified, the 
  5782. number of the list item, and a tail added by the program. The compound 
  5783. variables are listed in the parameters section. 
  5784.  
  5785. "stemname.0", is set to the number of items in the list, so as to ensure that 
  5786. all the list items are looked at. 
  5787.  
  5788. stemname is in quotes to ensure that its case is correct. 
  5789.  
  5790.  
  5791. ΓòÉΓòÉΓòÉ <hidden> PsnsListVolumes - Related functions ΓòÉΓòÉΓòÉ
  5792.  
  5793.      PsnsActivateVolume 
  5794.  
  5795.      PsnsAssociateVolume 
  5796.  
  5797.      PsnsCreateVolume 
  5798.  
  5799.      PsnsDeleteVolume 
  5800.  
  5801.      PsnsListVolumeBackupSets 
  5802.  
  5803.      PsnsVolumeInfo 
  5804.  
  5805.  
  5806. ΓòÉΓòÉΓòÉ 4.63. PsnsPurgeFiles ΓòÉΓòÉΓòÉ
  5807.  
  5808. Select an item 
  5809.  
  5810.      Syntax 
  5811.      Parameters 
  5812.      Returns 
  5813.      Remarks 
  5814.      Example 
  5815.      Related functions 
  5816.  
  5817.  
  5818. ΓòÉΓòÉΓòÉ <hidden> PsnsPurgeFiles - Syntax ΓòÉΓòÉΓòÉ
  5819.  
  5820. /***************************************************/
  5821. /* This function empties the list of files to be   */
  5822. /* backed up or restored.                          */
  5823. /***************************************************/
  5824.  
  5825. Call PsnsPurgeFiles handle
  5826.  
  5827.  
  5828. ΓòÉΓòÉΓòÉ <hidden> PsnsPurgeFiles - Parameters ΓòÉΓòÉΓòÉ
  5829.  
  5830.  handle 
  5831.            Handle returned by PsnsInit 
  5832.  
  5833.  
  5834. ΓòÉΓòÉΓòÉ <hidden> PsnsPurgeFiles - Returns ΓòÉΓòÉΓòÉ
  5835.  
  5836.       PSNS_OK 
  5837.       PSNS_HANDLE_IN_USE 
  5838.       PSNS_COMMUNICATIONS_ERROR 
  5839.       PSNS_INVALID_HANDLE 
  5840.       REXX_INVALID_HANDLE 
  5841.       REXX_INVALID_PARAMETER 
  5842.  
  5843.  
  5844. ΓòÉΓòÉΓòÉ <hidden> PsnsPurgeFiles - Remarks ΓòÉΓòÉΓòÉ
  5845.  
  5846. Use this function to empty the list of files which you have created using 
  5847. PsnsAddFile. This means that you can start creating a new list of files to be 
  5848. backed up or restored. 
  5849.  
  5850. Note:  This function does nothing to the files you have added to the list, it 
  5851. simply empties the list. 
  5852.  
  5853.  
  5854. ΓòÉΓòÉΓòÉ <hidden> PsnsPurgeFiles - Related functions ΓòÉΓòÉΓòÉ
  5855.  
  5856.      PsnsAddFile 
  5857.  
  5858.      PsnsBackupFiles 
  5859.  
  5860.      PsnsDropFiles 
  5861.  
  5862.      PsnsListFiles 
  5863.  
  5864.      PsnsRestoreFiles 
  5865.  
  5866.  
  5867. ΓòÉΓòÉΓòÉ 4.64. PsnsRefreshSourceDrives ΓòÉΓòÉΓòÉ
  5868.  
  5869. Select an item 
  5870.  
  5871.      Syntax 
  5872.      Parameters 
  5873.      Returns 
  5874.      Remarks 
  5875.      Example 
  5876.      Related functions 
  5877.  
  5878.  
  5879. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshSourceDrives - Syntax ΓòÉΓòÉΓòÉ
  5880.  
  5881. /****************************************************/
  5882. /* This function looks for drives on the system and */
  5883. /* refreshes the list of source drives.              */
  5884. /****************************************************/
  5885.  
  5886. Call PsnsRefreshSourceDrives handle
  5887.  
  5888.  
  5889. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshSourceDrives - Parameters ΓòÉΓòÉΓòÉ
  5890.  
  5891.  handle 
  5892.            Handle returned by PsnsInit 
  5893.  
  5894.  
  5895. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshSourceDrives - Returns ΓòÉΓòÉΓòÉ
  5896.  
  5897.       PSNS_OK 
  5898.       PSNS_HANDLE_IN_USE 
  5899.       PSNS_COMMUNICATIONS_ERROR 
  5900.       PSNS_INVALID_HANDLE 
  5901.       REXX_INVALID_HANDLE 
  5902.  
  5903.  
  5904. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshSourceDrives - Remarks ΓòÉΓòÉΓòÉ
  5905.  
  5906. Use this function to make OS/2 Warp Server Backup/Restore scan for drives and 
  5907. automatically refresh the list of source drives. This happens automatically 
  5908. every time OS/2 Warp Server Backup/Restore starts up. 
  5909.  
  5910.  
  5911. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshSourceDrives - Related functions ΓòÉΓòÉΓòÉ
  5912.  
  5913.      PsnsListSourceDrives 
  5914.  
  5915.      PsnsSelectSourceDrive 
  5916.  
  5917.      PsnsSourceDriveType 
  5918.  
  5919.  
  5920. ΓòÉΓòÉΓòÉ 4.65. PsnsRefreshStorageDevices ΓòÉΓòÉΓòÉ
  5921.  
  5922. Select an item 
  5923.  
  5924.      Syntax 
  5925.      Parameters 
  5926.      Returns 
  5927.      Remarks 
  5928.      Example 
  5929.      Related functions 
  5930.  
  5931.  
  5932. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshStorageDevices - Syntax ΓòÉΓòÉΓòÉ
  5933.  
  5934. /****************************************************/
  5935. /* This function looks for locally attached storage */
  5936. /* devices and automatically adds them to the list  */
  5937. /* of storage devices.                              */
  5938. /****************************************************/
  5939.  
  5940. Call PsnsRefreshStorageDevices handle
  5941.  
  5942.  
  5943. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshStorageDevices - Parameters ΓòÉΓòÉΓòÉ
  5944.  
  5945.  handle 
  5946.            Handle returned by PsnsInit 
  5947.  
  5948.  
  5949. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshStorageDevices - Returns ΓòÉΓòÉΓòÉ
  5950.  
  5951.       PSNS_OK 
  5952.       PSNS_HANDLE_IN_USE 
  5953.       PSNS_COMMUNICATIONS_ERROR 
  5954.       PSNS_INVALID_HANDLE 
  5955.       REXX_INVALID_HANDLE 
  5956.  
  5957.  
  5958. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshStorageDevices - Remarks ΓòÉΓòÉΓòÉ
  5959.  
  5960. Use this function to make OS/2 Warp Server Backup/Restore scan for locally 
  5961. attached storage devices and add them to the list of storage devices. This 
  5962. happens automatically every time OS/2 Warp Server Backup/Restore starts up. 
  5963.  
  5964.  
  5965. ΓòÉΓòÉΓòÉ <hidden> PsnsRefreshStorageDevices - Related functions ΓòÉΓòÉΓòÉ
  5966.  
  5967.      PsnsCreateStorageDevice 
  5968.  
  5969.      PsnsDeleteStorageDevice 
  5970.  
  5971.      PsnsGetStorageDeviceConfig 
  5972.  
  5973.      PsnsListCreatableStorageDevices 
  5974.  
  5975.      PsnsListStorageDevices 
  5976.  
  5977.      PsnsSetStorageDeviceConfig 
  5978.  
  5979.      PsnsStorageDeviceInfo 
  5980.  
  5981.  
  5982. ΓòÉΓòÉΓòÉ 4.66. PsnsRenameBackupMethod ΓòÉΓòÉΓòÉ
  5983.  
  5984. Select an item 
  5985.  
  5986.      Syntax 
  5987.      Parameters 
  5988.      Returns 
  5989.      Remarks 
  5990.      Example 
  5991.      Related functions 
  5992.  
  5993.  
  5994. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  5995.  
  5996. /***************************************************/
  5997. /* This function renames an existing backup method */
  5998. /***************************************************/
  5999.  
  6000. Call PsnsRenameBackupMethod handle, "name", "newName"
  6001.  
  6002.  
  6003. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  6004.  
  6005.  handle 
  6006.            Handle returned by PsnsInit 
  6007.  
  6008.  "name" 
  6009.            The name of the backup method 
  6010.  
  6011.  "newName" 
  6012.            The new name of the backup method 
  6013.  
  6014.  
  6015. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameBackupMethod - Returns ΓòÉΓòÉΓòÉ
  6016.  
  6017.       PSNS_OK 
  6018.       PSNS_HANDLE_IN_USE 
  6019.       PSNS_COMMUNICATIONS_ERROR 
  6020.       PSNS_INVALID_HANDLE 
  6021.       PSNS_INVALID_BACKUP_METHOD 
  6022.       PSNS_ALREADY_EXISTS 
  6023.       PSNS_INVALID_NAME 
  6024.       PSNS_IN_USE 
  6025.       REXX_INVALID_HANDLE 
  6026.  
  6027.  
  6028. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  6029.  
  6030. Use this function to rename a backup method. newName must not be the name of 
  6031. any existing backup method. 
  6032.  
  6033. name and newName are in quotes to ensure that their cases are correct. 
  6034.  
  6035.  
  6036. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  6037.  
  6038.      PsnsBackupMethodInfo 
  6039.  
  6040.      PsnsCopyBackupMethod 
  6041.  
  6042.      PsnsCreateBackupMethod 
  6043.  
  6044.      PsnsDeleteBackupMethod 
  6045.  
  6046.      PsnsEstimateBackupMethod 
  6047.  
  6048.      PsnsListBackupMethods 
  6049.  
  6050.      PsnsRunBackupMethod 
  6051.  
  6052.  
  6053. ΓòÉΓòÉΓòÉ 4.67. PsnsRenameFileFilter ΓòÉΓòÉΓòÉ
  6054.  
  6055. Select an item 
  6056.  
  6057.      Syntax 
  6058.      Parameters 
  6059.      Returns 
  6060.      Remarks 
  6061.      Example 
  6062.      Related functions 
  6063.  
  6064.  
  6065. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameFileFilter - Syntax ΓòÉΓòÉΓòÉ
  6066.  
  6067. /***************************************************/
  6068. /* This function renames an existing file filter   */
  6069. /***************************************************/
  6070.  
  6071. Call PsnsRenameFileFilter handle, "name", "newName"
  6072.  
  6073.  
  6074. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameFileFilter - Parameters ΓòÉΓòÉΓòÉ
  6075.  
  6076.  handle 
  6077.            Handle returned by PsnsInit 
  6078.  
  6079.  "name" 
  6080.            The name of the file filter 
  6081.  
  6082.  "newName" 
  6083.            The new name of the file filter 
  6084.  
  6085.  
  6086. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameFileFilter - Returns ΓòÉΓòÉΓòÉ
  6087.  
  6088.       PSNS_OK 
  6089.       PSNS_HANDLE_IN_USE 
  6090.       PSNS_COMMUNICATIONS_ERROR 
  6091.       PSNS_INVALID_HANDLE 
  6092.       PSNS_INVALID_FILE_FILTER 
  6093.       PSNS_ALREADY_EXISTS 
  6094.       PSNS_INVALID_NAME 
  6095.       PSNS_IN_USE 
  6096.       REXX_INVALID_HANDLE 
  6097.  
  6098.  
  6099. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameFileFilter - Remarks ΓòÉΓòÉΓòÉ
  6100.  
  6101. Use this function to rename a file filter. newName must not be the name of any 
  6102. existing file filter. 
  6103.  
  6104. name and newName are in quotes to ensure that their cases are correct. 
  6105.  
  6106.  
  6107. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameFileFilter - Related functions ΓòÉΓòÉΓòÉ
  6108.  
  6109.      PsnsCopyFileFilter 
  6110.  
  6111.      PsnsCreateFileFilter 
  6112.  
  6113.      PsnsDeleteFileFilter 
  6114.  
  6115.      PsnsFileFilterInfo 
  6116.  
  6117.      PsnsListFileFilters 
  6118.  
  6119.  
  6120. ΓòÉΓòÉΓòÉ 4.68. PsnsRenameRestoreMethod ΓòÉΓòÉΓòÉ
  6121.  
  6122. Select an item 
  6123.  
  6124.      Syntax 
  6125.      Parameters 
  6126.      Returns 
  6127.      Remarks 
  6128.      Example 
  6129.      Related functions 
  6130.  
  6131.  
  6132. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  6133.  
  6134. /****************************************************/
  6135. /* This function renames an existing restore method */
  6136. /****************************************************/
  6137.  
  6138. Call PsnsRenameRestoreMethod handle, "name", "newName"
  6139.  
  6140.  
  6141. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  6142.  
  6143.  handle 
  6144.            Handle returned by PsnsInit 
  6145.  
  6146.  "name" 
  6147.            The name of the restore method 
  6148.  
  6149.  "newName" 
  6150.            The new name of the restore method 
  6151.  
  6152.  
  6153. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  6154.  
  6155.       PSNS_OK 
  6156.       PSNS_HANDLE_IN_USE 
  6157.       PSNS_COMMUNICATIONS_ERROR 
  6158.       PSNS_INVALID_HANDLE 
  6159.       PSNS_INVALID_RESTORE_METHOD 
  6160.       PSNS_ALREADY_EXISTS 
  6161.       PSNS_INVALID_NAME 
  6162.       PSNS_IN_USE 
  6163.       REXX_INVALID_HANDLE 
  6164.  
  6165.  
  6166. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  6167.  
  6168. Use this function to rename a restore method. newName must not be the name of 
  6169. any existing restore method. 
  6170.  
  6171. name and newName are in quotes to ensure that their cases are correct. 
  6172.  
  6173.  
  6174. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  6175.  
  6176.      PsnsCopyRestoreMethod 
  6177.  
  6178.      PsnsCreateRestoreMethod 
  6179.  
  6180.      PsnsDeleteRestoreMethod 
  6181.  
  6182.      PsnsEstimateRestoreMethod 
  6183.  
  6184.      PsnsListRestoreMethods 
  6185.  
  6186.      PsnsRestoreMethodInfo 
  6187.  
  6188.      PsnsRunRestoreMethod 
  6189.  
  6190.  
  6191. ΓòÉΓòÉΓòÉ 4.69. PsnsRenameRulebook ΓòÉΓòÉΓòÉ
  6192.  
  6193. Select an item 
  6194.  
  6195.      Syntax 
  6196.      Parameters 
  6197.      Returns 
  6198.      Remarks 
  6199.      Example 
  6200.      Related functions 
  6201.  
  6202.  
  6203. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRulebook - Syntax ΓòÉΓòÉΓòÉ
  6204.  
  6205. /***************************************************/
  6206. /* This function renames an existing rulebook      */
  6207. /***************************************************/
  6208.  
  6209. Call PsnsRenameRulebook handle, "name", "newName"
  6210.  
  6211.  
  6212. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRulebook - Parameters ΓòÉΓòÉΓòÉ
  6213.  
  6214.  handle 
  6215.            Handle returned by PsnsInit 
  6216.  
  6217.  "name" 
  6218.            The name of the rulebook 
  6219.  
  6220.  "newName" 
  6221.            The new name of the rulebook 
  6222.  
  6223.  
  6224. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRulebook - Returns ΓòÉΓòÉΓòÉ
  6225.  
  6226.       PSNS_OK 
  6227.       PSNS_HANDLE_IN_USE 
  6228.       PSNS_COMMUNICATIONS_ERROR 
  6229.       PSNS_INVALID_HANDLE 
  6230.       PSNS_INVALID_RULEBOOK 
  6231.       PSNS_ALREADY_EXISTS 
  6232.       PSNS_INVALID_NAME 
  6233.       PSNS_IN_USE 
  6234.       REXX_INVALID_HANDLE 
  6235.  
  6236.  
  6237. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRulebook - Remarks ΓòÉΓòÉΓòÉ
  6238.  
  6239. Use this function to rename a rulebook. newName must not be the name of any 
  6240. existing rulebook. 
  6241.  
  6242. name and newName are in quotes to ensure that their cases are correct. 
  6243.  
  6244.  
  6245. ΓòÉΓòÉΓòÉ <hidden> PsnsRenameRulebook - Related functions ΓòÉΓòÉΓòÉ
  6246.  
  6247.      PsnsCopyRulebook 
  6248.  
  6249.      PsnsCreateRulebook 
  6250.  
  6251.      PsnsDeleteRulebook 
  6252.  
  6253.      PsnsListRulebooks 
  6254.  
  6255.      PsnsRulebookInfo 
  6256.  
  6257.  
  6258. ΓòÉΓòÉΓòÉ 4.70. PsnsRestoreFiles ΓòÉΓòÉΓòÉ
  6259.  
  6260. Select an item 
  6261.  
  6262.      Syntax 
  6263.      Parameters 
  6264.      Returns 
  6265.      Remarks 
  6266.      Example 
  6267.      Related functions 
  6268.  
  6269.  
  6270. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreFiles - Syntax ΓòÉΓòÉΓòÉ
  6271.  
  6272. /***************************************************/
  6273. /* This function restores a list of files created  */
  6274. /* by calls to PsnsAddFile                         */
  6275. /***************************************************/
  6276.  
  6277. Call PsnsRestoreFiles handle, "stemname"
  6278.  
  6279.  
  6280. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreFiles - Parameters ΓòÉΓòÉΓòÉ
  6281.  
  6282.  handle 
  6283.            Handle returned by PsnsInit 
  6284.  
  6285.  "stemname" 
  6286.            The name of the stem from which information is to be taken. 
  6287.  
  6288.            Parameters to use are: 
  6289.  
  6290.                                0backupSet
  6291.                     This can be any one of the following: 
  6292.  
  6293.                          The name of the backup set from which the files are to 
  6294.                          be restored 
  6295.  
  6296.                          An asterisk (*) to restore files from all backup sets 
  6297.  
  6298.                          A zero length string (defined by two consecutive 
  6299.                          single or double quotation marks) to restore files 
  6300.                          from the default backup set. 
  6301.  
  6302.  
  6303. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreFiles - Returns ΓòÉΓòÉΓòÉ
  6304.  
  6305.       PSNS_OK 
  6306.       PSNS_HANDLE_IN_USE 
  6307.       PSNS_COMMUNICATIONS_ERROR 
  6308.       PSNS_INVALID_HANDLE 
  6309.       PSNS_INVALID_BACKUP_SET 
  6310.       PSNS_TRANSFERRED_OUT 
  6311.       PSNS_IN_USE 
  6312.       REXX_INVALID_HANDLE 
  6313.  
  6314.  
  6315. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreFiles - Remarks ΓòÉΓòÉΓòÉ
  6316.  
  6317. Use this function to restore a list of files. 
  6318.  
  6319. stemname is in quotes to ensure that its case is correct. 
  6320.  
  6321.  
  6322. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreFiles - Related functions ΓòÉΓòÉΓòÉ
  6323.  
  6324.      PsnsAddFile 
  6325.  
  6326.      PsnsBackupFiles 
  6327.  
  6328.      PsnsDropFiles 
  6329.  
  6330.      PsnsListFiles 
  6331.  
  6332.      PsnsPurgeFiles 
  6333.  
  6334.  
  6335. ΓòÉΓòÉΓòÉ 4.71. PsnsRestoreMethodInfo ΓòÉΓòÉΓòÉ
  6336.  
  6337. Select an item 
  6338.  
  6339.      Syntax 
  6340.      Parameters 
  6341.      Returns 
  6342.      Remarks 
  6343.      Example 
  6344.      Related functions 
  6345.  
  6346.  
  6347. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreMethodInfo - Syntax ΓòÉΓòÉΓòÉ
  6348.  
  6349. /***************************************************/
  6350. /* This function gets or sets all the information  */
  6351. /* about a restore method                          */
  6352. /***************************************************/
  6353.  
  6354. Call PsnsRestoreMethodInfo handle, "stemname"
  6355.  
  6356.  
  6357. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreMethodInfo - Parameters ΓòÉΓòÉΓòÉ
  6358.  
  6359.  handle 
  6360.            Handle returned by PsnsInit 
  6361.  
  6362.  "stemname" 
  6363.            The name of the stem from which information is to be taken and/or 
  6364.            put into. 
  6365.  
  6366.            Stemname parameters which may have their values changed or filled in 
  6367.            by the API are: 
  6368.  
  6369.                                0name
  6370.                     The name of the restore method; this is always required. 
  6371.  
  6372.                                0description
  6373.                     The description of the restore method. 
  6374.  
  6375.                                0backupSet
  6376.                     This can be any one of the following: 
  6377.  
  6378.                          The name of the backup set from which the restore is 
  6379.                          to be made 
  6380.  
  6381.                          An asterisk (*) to restore from all backup sets 
  6382.  
  6383.                          A zero length string (defined by two consecutive 
  6384.                          single or double quotation marks) to restore from the 
  6385.                          default backup set. 
  6386.  
  6387.                                0allFiles
  6388.                     Possible values are: 
  6389.  
  6390.                     1        Allow any file to be restored; the drive, 
  6391.                              directory, pattern and subdirectories fields are 
  6392.                              ignored. 
  6393.                     0        Allow only those files specified by the drive, 
  6394.                              directory, pattern and subdirectories fields to be 
  6395.                              restored. 
  6396.  
  6397.                                0drive
  6398.                     Original drive of the files to be restored. 
  6399.  
  6400.                                0directory
  6401.                     Original directory of the files to be restored. 
  6402.  
  6403.                                0pattern
  6404.                     Wildcard selecting which files are to be restored. 
  6405.  
  6406.                                0subdirectories
  6407.                     Possible values are: 
  6408.  
  6409.                     1      Restore files in subdirectories of the selected 
  6410.                            directory. 
  6411.                     0      Do not restore files in subdirectories. 
  6412.  
  6413.                                0byDate
  6414.                     Possible values are: 
  6415.  
  6416.                     1      Restore files as they were on the date specified in 
  6417.                            the date and time fields below. 
  6418.                     0      Restore the most recent generation of each file. 
  6419.  
  6420.                                0day
  6421.                     Files will be restored to the state they were in on this 
  6422.                     date if byDate is set to 1. 
  6423.  
  6424.                                0month
  6425.                     Files will be restored to the state they were in on this 
  6426.                     date if byDate is set to 1. 
  6427.  
  6428.                                0year
  6429.                     Files will be restored to the state they were in on this 
  6430.                     date if byDate is set to 1. 
  6431.  
  6432.                                0hours
  6433.                     Files will be restored to the state they were in at this 
  6434.                     time if byDate is set to 1. 
  6435.  
  6436.                                0minutes
  6437.                     Files will be restored to the state they were in at this 
  6438.                     time if byDate is set to 1. 
  6439.  
  6440.                                0seconds
  6441.                     Files will be restored to the state they were in at this 
  6442.                     time if byDate is set to 1. 
  6443.  
  6444.            0preview: 
  6445.  
  6446.                     1      Show a preview before the restore, which allows the 
  6447.                            user to select or deselect individual files. 
  6448.                     0      No preview is shown before the restore. 
  6449.  
  6450.                     Note:  Showing a preview is only useful if the restore 
  6451.                     method is to be run from the OS/2 Warp Server 
  6452.                     Backup/Restore window; it is not possible to show a preview 
  6453.                     when running a restore method using the API. 
  6454.  
  6455.                                0prompt
  6456.                     Possible values are: 
  6457.  
  6458.                     1      Prompt the user to select a generation of each file 
  6459.                            to be restored. 
  6460.                     0      The user is not prompted; the most recent generation 
  6461.                            of each file is restored. 
  6462.  
  6463.                     Note:  This is only useful if the restore method is to be 
  6464.                     run from the OS/2 Warp Server Backup/Restore window; it is 
  6465.                     not possible to pick generations when running a restore 
  6466.                     method using the API. 
  6467.  
  6468.                                0originalLocation
  6469.                     Possible values are: 
  6470.  
  6471.                     1      Files are restored to their original locations; 
  6472.                            destinationDrive and destinationPath are ignored. 
  6473.                     0      Files are restored to the drive and path specified 
  6474.                            in destinationDrive and destinationPath. 
  6475.  
  6476.                                0destinationDrive
  6477.                     The drive to which to files are to be restored if 
  6478.                     originalLocation is set to 0. 
  6479.  
  6480.                                0destinationPath
  6481.                     The path to which files are to be restored if 
  6482.                     originalLocation is set to 0. 
  6483.  
  6484.  
  6485. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreMethodInfo - Returns ΓòÉΓòÉΓòÉ
  6486.  
  6487.       PSNS_OK 
  6488.       PSNS_HANDLE_IN_USE 
  6489.       PSNS_COMMUNICATIONS_ERROR 
  6490.       PSNS_INVALID_HANDLE 
  6491.       PSNS_INVALID_RESTORE_METHOD 
  6492.       PSNS_INVALID_BACKUP_SET 
  6493.       PSNS_INVALID_DRIVE 
  6494.       PSNS_INVALID_PATH 
  6495.       PSNS_INVALID_FILENAME 
  6496.       PSNS_INVALID_MASK 
  6497.       PSNS_IN_USE 
  6498.       REXX_INVALID_HANDLE 
  6499.       REXX_INVALID_MASK_NAME 
  6500.  
  6501.  
  6502. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreMethodInfo - Remarks ΓòÉΓòÉΓòÉ
  6503.  
  6504. Use this function to change a restore method or to inspect the current 
  6505. settings. In order to look at the settings, without changing any, do not create 
  6506. any compound variables except that of the restore method name, the API then 
  6507. fills in all the compound variables, so as to show the settings. 
  6508.  
  6509. Putting in a parameter means that it will be changed, from its old value. This, 
  6510. however is not true for the name field. It is not possible to change the name 
  6511. of a restore method with this call; to do that, use PsnsRenameRestoreMethod 
  6512.  
  6513. stemname is in quotes to ensure that its case is correct. 
  6514.  
  6515.  
  6516. ΓòÉΓòÉΓòÉ <hidden> PsnsRestoreMethodInfo - Related functions ΓòÉΓòÉΓòÉ
  6517.  
  6518.      PsnsCopyRestoreMethod 
  6519.  
  6520.      PsnsCreateRestoreMethod 
  6521.  
  6522.      PsnsDeleteRestoreMethod 
  6523.  
  6524.      PsnsEstimateRestoreMethod 
  6525.  
  6526.      PsnsListRestoreMethods 
  6527.  
  6528.      PsnsRenameRestoreMethod 
  6529.  
  6530.      PsnsRunRestoreMethod 
  6531.  
  6532.  
  6533. ΓòÉΓòÉΓòÉ 4.72. PsnsRulebookInfo ΓòÉΓòÉΓòÉ
  6534.  
  6535. Select an item 
  6536.  
  6537.      Syntax 
  6538.      Parameters 
  6539.      Returns 
  6540.      Remarks 
  6541.      Example 
  6542.      Related functions 
  6543.  
  6544.  
  6545. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookInfo - Syntax ΓòÉΓòÉΓòÉ
  6546.  
  6547. /***************************************************/
  6548. /* This function gets or sets all the information  */
  6549. /* about a rulebook                                */
  6550. /***************************************************/
  6551.  
  6552. Call PsnsRulebookInfo handle, "stemname"
  6553.  
  6554.  
  6555. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookInfo - Parameters ΓòÉΓòÉΓòÉ
  6556.  
  6557.  handle 
  6558.            Handle returned by PsnsInit 
  6559.  
  6560.  "stemname" 
  6561.            The name of the stem from which information is to be taken and/or 
  6562.            put into. 
  6563.  
  6564.            Stemname parameters which may have their values changed or filled in 
  6565.            by the API are: 
  6566.  
  6567.                                0name
  6568.                     The name of the rulebook. This is always required. 
  6569.  
  6570.                                0description
  6571.                     Description of the rulebook. 
  6572.  
  6573.  
  6574. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookInfo - Returns ΓòÉΓòÉΓòÉ
  6575.  
  6576.       PSNS_OK 
  6577.       PSNS_HANDLE_IN_USE 
  6578.       PSNS_COMMUNICATIONS_ERROR 
  6579.       PSNS_INVALID_HANDLE 
  6580.       PSNS_INVALID_RULEBOOK 
  6581.       PSNS_IN_USE 
  6582.       PSNS_INVALID_MASK 
  6583.       REXX_INVALID_HANDLE 
  6584.  
  6585.  
  6586. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookInfo - Remarks ΓòÉΓòÉΓòÉ
  6587.  
  6588. Use this function to change a rulebook or to inspect the current settings of a 
  6589. rulebook. In order to look at the settings, without changing any, do not create 
  6590. any compound variables, except that of the rulebook name, the API then fills in 
  6591. all the compound variables, so as to show the current settings. 
  6592.  
  6593. Putting in a parameter means that it will be changed, from its old value. This, 
  6594. however is not true for the name field. It is not possible to change the name 
  6595. of a rulebook with this call; to do that, use PsnsRenameRulebook. 
  6596.  
  6597. stemname is in quotes to ensure that its case is correct. 
  6598.  
  6599.  
  6600. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookInfo - Related functions ΓòÉΓòÉΓòÉ
  6601.  
  6602.      PsnsCopyRulebook 
  6603.  
  6604.      PsnsCreateRulebook 
  6605.  
  6606.      PsnsDeleteRulebook 
  6607.  
  6608.      PsnsListRulebooks 
  6609.  
  6610.      PsnsRenameRulebook 
  6611.  
  6612.  
  6613. ΓòÉΓòÉΓòÉ 4.73. PsnsRulebookRuleInfo ΓòÉΓòÉΓòÉ
  6614.  
  6615. Select an item 
  6616.  
  6617.      Syntax 
  6618.      Parameters 
  6619.      Returns 
  6620.      Remarks 
  6621.      Example 
  6622.      Related functions 
  6623.  
  6624.  
  6625. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookRuleInfo - Syntax ΓòÉΓòÉΓòÉ
  6626.  
  6627. /***************************************************/
  6628. /* This function gets or sets all the information  */
  6629. /* about a rule in a rulebook                      */
  6630. /***************************************************/
  6631.  
  6632. Call PsnsRulebookRuleInfo handle, "stemname",
  6633.                           position, "rulebookName"
  6634.  
  6635.  
  6636. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookRuleInfo - Parameters ΓòÉΓòÉΓòÉ
  6637.  
  6638.  handle 
  6639.            Handle returned by PsnsInit 
  6640.  
  6641.  "stemname" 
  6642.            The name of the stem from which information is to be taken and/or 
  6643.            put into. 
  6644.  
  6645.            Stemname parameters which may have their values changed or filled in 
  6646.            by the API are: 
  6647.  
  6648.                                0drive
  6649.                     The drive letter to be included / excluded, or an asterisk 
  6650.                     (*) for all drives. 
  6651.  
  6652.                                0directory
  6653.                     The directory to be included / excluded. 
  6654.  
  6655.                                0pattern
  6656.                     Wildcard specifying which files are to be included / 
  6657.                     excluded. 
  6658.  
  6659.                                0subdirectories
  6660.                     Possible values are: 
  6661.  
  6662.                     1      Include / exclude subdirectories in the specified 
  6663.                            directory. 
  6664.                     0      Do not include / exclude subdirectories. 
  6665.  
  6666.                                0generations
  6667.                     Number of generations to keep of specified files. 
  6668.  
  6669.                                0compression
  6670.                     Possible values are: 
  6671.  
  6672.                     NOCOMPRESSION       Compress the specified files. 
  6673.                     COMPRESSION         Do not compress the specified files. 
  6674.                     DEFAULT             Use the default compression for the 
  6675.                                         specified files. 
  6676.  
  6677.  "rulebookName" 
  6678.            Name of the rulebook to which the rule is to be added. 
  6679.  
  6680.  position 
  6681.            This specifies the position where the rule is to be added to the 
  6682.            file filter; 1 means add at the beginning, 2 after the first rule 
  6683.            and so on. 
  6684.  
  6685.  
  6686. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookRuleInfo - Returns ΓòÉΓòÉΓòÉ
  6687.  
  6688.       PSNS_OK 
  6689.       PSNS_HANDLE_IN_USE 
  6690.       PSNS_COMMUNICATIONS_ERROR 
  6691.       PSNS_INVALID_HANDLE 
  6692.       PSNS_INVALID_RULEBOOK 
  6693.       PSNS_INVALID_POSITION 
  6694.       PSNS_INVALID_DRIVE 
  6695.       PSNS_INVALID_PATH 
  6696.       PSNS_INVALID_FILENAME 
  6697.       PSNS_INVALID_GENERATIONS 
  6698.       PSNS_INVALID_COMPRESSION 
  6699.       PSNS_IN_USE 
  6700.       PSNS_INVALID_MASK 
  6701.       REXX_INVALID_HANDLE 
  6702.       REXX_INVALID_MASK_NAME 
  6703.  
  6704.  
  6705. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookRuleInfo - Remarks ΓòÉΓòÉΓòÉ
  6706.  
  6707. Use this function to change a rulebook rule or to inspect the current settings 
  6708. of a rulebook rule. In order to look at the settings without changing any, do 
  6709. not create any compound variables, the API then fills in all the compound 
  6710. variables, so as to show the current settings. 
  6711.  
  6712. Putting in a parameter means that it will be changed, from its old value. 
  6713.  
  6714. stemname and rulebookName are in quotes to ensure that their cases are correct. 
  6715.  
  6716.  
  6717. ΓòÉΓòÉΓòÉ <hidden> PsnsRulebookRuleInfo - Related functions ΓòÉΓòÉΓòÉ
  6718.  
  6719.      PsnsAddRulebookRule 
  6720.  
  6721.      PsnsDeleteRulebookRule 
  6722.  
  6723.      PsnsListRulebookRule 
  6724.  
  6725.  
  6726. ΓòÉΓòÉΓòÉ 4.74. PsnsRunBackupMethod ΓòÉΓòÉΓòÉ
  6727.  
  6728. Select an item 
  6729.  
  6730.      Syntax 
  6731.      Parameters 
  6732.      Returns 
  6733.      Remarks 
  6734.      Example 
  6735.      Related functions 
  6736.  
  6737.  
  6738. ΓòÉΓòÉΓòÉ <hidden> PsnsRunBackupMethod - Syntax ΓòÉΓòÉΓòÉ
  6739.  
  6740. /***************************************************/
  6741. /* This function runs a backup method              */
  6742. /***************************************************/
  6743.  
  6744. Call PsnsRunBackupMethod handle, "name"
  6745.  
  6746.  
  6747. ΓòÉΓòÉΓòÉ <hidden> PsnsRunBackupMethod - Parameters ΓòÉΓòÉΓòÉ
  6748.  
  6749.  handle 
  6750.            Handle returned by PsnsInit 
  6751.  
  6752.  "name" 
  6753.            The name of the backup method to run 
  6754.  
  6755.  
  6756. ΓòÉΓòÉΓòÉ <hidden> PsnsRunBackupMethod - Returns ΓòÉΓòÉΓòÉ
  6757.  
  6758.       PSNS_OK 
  6759.       PSNS_HANDLE_IN_USE 
  6760.       PSNS_COMMUNICATIONS_ERROR 
  6761.       PSNS_INVALID_HANDLE 
  6762.       PSNS_INVALID_BACKUP_METHOD 
  6763.       PSNS_ARCHIVE_ERROR 
  6764.       PSNS_IN_USE 
  6765.       PSNS_TRANSFERRED_OUT 
  6766.       REXX_INVALID_HANDLE 
  6767.  
  6768.  
  6769. ΓòÉΓòÉΓòÉ <hidden> PsnsRunBackupMethod - Remarks ΓòÉΓòÉΓòÉ
  6770.  
  6771. Use this function to run a backup method. 
  6772.  
  6773. name is in quotes to ensure that its case is correct. 
  6774.  
  6775.  
  6776. ΓòÉΓòÉΓòÉ <hidden> PsnsRunBackupMethod - Related functions ΓòÉΓòÉΓòÉ
  6777.  
  6778.      PsnsEstimateBackupMethod 
  6779.  
  6780.      PsnsEstimateRestoreMethod 
  6781.  
  6782.      PsnsRunRestoreMethod 
  6783.  
  6784.  
  6785. ΓòÉΓòÉΓòÉ 4.75. PsnsRunRestoreMethod ΓòÉΓòÉΓòÉ
  6786.  
  6787. Select an item 
  6788.  
  6789.      Syntax 
  6790.      Parameters 
  6791.      Returns 
  6792.      Remarks 
  6793.      Example 
  6794.      Related functions 
  6795.  
  6796.  
  6797. ΓòÉΓòÉΓòÉ <hidden> PsnsRunRestoreMethod - Syntax ΓòÉΓòÉΓòÉ
  6798.  
  6799. /***************************************************/
  6800. /* This function runs a restore method             */
  6801. /***************************************************/
  6802.  
  6803. Call PsnsRunRestoreMethod handle, "name",
  6804.                           "base", "incremental"
  6805.  
  6806.  
  6807. ΓòÉΓòÉΓòÉ <hidden> PsnsRunRestoreMethod - Parameters ΓòÉΓòÉΓòÉ
  6808.  
  6809.  handle 
  6810.            Handle returned by PsnsInit 
  6811.  
  6812.  "name" 
  6813.            The name of the restore method to run 
  6814.  
  6815.  "base" 
  6816.            This parameter is only used when running a restore method that 
  6817.            references a dual device backup set. It is omitted for single device 
  6818.            backup sets. 
  6819.  
  6820.            Possible values are: 
  6821.  
  6822.            1         Restore from the base storage device. 
  6823.            0         Do not restore from the base storage device. 
  6824.  
  6825.  "incremental" 
  6826.            This parameter is only used when running a restore method that 
  6827.            references a dual device backup set. It is omitted for single device 
  6828.            backup sets. 
  6829.  
  6830.            Possible values are: 
  6831.  
  6832.            1         Restore from the incremental storage device. 
  6833.            0         Do not restore from the incremental storage device. 
  6834.  
  6835.  
  6836. ΓòÉΓòÉΓòÉ <hidden> PsnsRunRestoreMethod - Returns ΓòÉΓòÉΓòÉ
  6837.  
  6838.       PSNS_OK 
  6839.       PSNS_HANDLE_IN_USE 
  6840.       PSNS_COMMUNICATIONS_ERROR 
  6841.       PSNS_INVALID_HANDLE 
  6842.       PSNS_INVALID_RESTORE_METHOD 
  6843.       PSNS_ARCHIVE_ERROR 
  6844.       PSNS_IN_USE 
  6845.       PSNS_TRANSFERRED_OUT 
  6846.       REXX_INVALID_HANDLE 
  6847.  
  6848.  
  6849. ΓòÉΓòÉΓòÉ <hidden> PsnsRunRestoreMethod - Remarks ΓòÉΓòÉΓòÉ
  6850.  
  6851. Use this function to run a restore method. When running a restore method which 
  6852. uses a normal, single storage device backup set, the last two parameters should 
  6853. be omitted. When running a restore method which uses a dual device backup set, 
  6854. specify all parameters. 
  6855.  
  6856. name, base and incremental are in quotes to ensure that their case is correct. 
  6857.  
  6858.  
  6859. ΓòÉΓòÉΓòÉ <hidden> PsnsRunRestoreMethod - Related functions ΓòÉΓòÉΓòÉ
  6860.  
  6861.      PsnsEstimateBackupMethod 
  6862.  
  6863.      PsnsEstimateRestoreMethod 
  6864.  
  6865.      PsnsRunBackupMethod 
  6866.  
  6867.  
  6868. ΓòÉΓòÉΓòÉ 4.76. PsnsSelectSourceDrive ΓòÉΓòÉΓòÉ
  6869.  
  6870. Select an item 
  6871.  
  6872.      Syntax 
  6873.      Parameters 
  6874.      Returns 
  6875.      Remarks 
  6876.      Example 
  6877.      Related functions 
  6878.  
  6879.  
  6880. ΓòÉΓòÉΓòÉ <hidden> PsnsSelectSourceDrive - Syntax ΓòÉΓòÉΓòÉ
  6881.  
  6882. /****************************************************/
  6883. /* This function selects whether or not a source    */
  6884. /* drive should be checked for files to back up.    */
  6885. /****************************************************/
  6886.  
  6887. Call PsnsSelectSourceDrive handle, "drive", "use"
  6888.  
  6889.  
  6890. ΓòÉΓòÉΓòÉ <hidden> PsnsSelectSourceDrive - Parameters ΓòÉΓòÉΓòÉ
  6891.  
  6892.  handle 
  6893.            Handle returned by PsnsInit 
  6894.  
  6895.  "drive" 
  6896.            Drive letter to select or deselect. 
  6897.  
  6898.  "use" 
  6899.  
  6900.            SELECT       Select this source drive for backup. 
  6901.            DESELECT     Deselect this source drive for backup. 
  6902.  
  6903.  
  6904. ΓòÉΓòÉΓòÉ <hidden> PsnsSelectSourceDrive - Returns ΓòÉΓòÉΓòÉ
  6905.  
  6906.       PSNS_OK 
  6907.       PSNS_HANDLE_IN_USE 
  6908.       PSNS_COMMUNICATIONS_ERROR 
  6909.       PSNS_INVALID_HANDLE 
  6910.       PSNS_INVALID_SOURCE_DRIVE 
  6911.       REXX_INVALID_HANDLE 
  6912.       REXX_INVALID_PARAMETER 
  6913.  
  6914.  
  6915. ΓòÉΓòÉΓòÉ <hidden> PsnsSelectSourceDrive - Remarks ΓòÉΓòÉΓòÉ
  6916.  
  6917. Use this function to tell OS/2 Warp Server Backup/Restore whether or not to 
  6918. check a source drive for files when performing a backup. For example, if you 
  6919. had a backup method to back up all program source files on your computer, you 
  6920. would probably want to check all local drives but not check any network drives 
  6921. you have attatched. 
  6922.  
  6923. By default, local drives are selected and remote drives are not selected. 
  6924.  
  6925. drive and use are in quotes to ensure that their cases are correct. 
  6926.  
  6927.  
  6928. ΓòÉΓòÉΓòÉ <hidden> PsnsSelectSourceDrive - Related functions ΓòÉΓòÉΓòÉ
  6929.  
  6930.      PsnsListSourceDrives 
  6931.  
  6932.      PsnsRefreshSourceDrives 
  6933.  
  6934.      PsnsSourceDriveType 
  6935.  
  6936.  
  6937. ΓòÉΓòÉΓòÉ 4.77. PsnsSetBackupSetConfig ΓòÉΓòÉΓòÉ
  6938.  
  6939. Select an item 
  6940.  
  6941.      Syntax 
  6942.      Parameters 
  6943.      Returns 
  6944.      Remarks 
  6945.      Example 
  6946.      Related functions 
  6947.  
  6948.  
  6949. ΓòÉΓòÉΓòÉ <hidden> PsnsSetBackupSetConfig - Syntax ΓòÉΓòÉΓòÉ
  6950.  
  6951. /****************************************************/
  6952. /* This function sets the configuration information */
  6953. /* for a backup set.                                */
  6954. /****************************************************/
  6955.  
  6956. Call PsnsSetBackupSetConfig handle, "setName",
  6957.                            "configString", "incConfigString"
  6958.  
  6959.  
  6960. ΓòÉΓòÉΓòÉ <hidden> PsnsSetBackupSetConfig - Parameters ΓòÉΓòÉΓòÉ
  6961.  
  6962.  handle 
  6963.            Handle returned by PsnsInit 
  6964.  
  6965.  "setName" 
  6966.            The name of the backup set to configure 
  6967.  
  6968.  "configString" 
  6969.            Configuration string for the backup set. The format of this string 
  6970.            depends on which storage device the backup set uses. For dual device 
  6971.            backup sets this is the configuration string for the base backup 
  6972.            set. 
  6973.  
  6974.  "incConfigString" 
  6975.            Configuration string for the incremental storage device of a dual 
  6976.            backup set. The format of this string depends on which storage 
  6977.            device the backup set uses. For single device backup sets this 
  6978.            argument should be omitted. 
  6979.  
  6980.  
  6981. ΓòÉΓòÉΓòÉ <hidden> PsnsSetBackupSetConfig - Returns ΓòÉΓòÉΓòÉ
  6982.  
  6983.       PSNS_OK 
  6984.       PSNS_HANDLE_IN_USE 
  6985.       PSNS_COMMUNICATIONS_ERROR 
  6986.       PSNS_INVALID_HANDLE 
  6987.       PSNS_INVALID_BACKUP_SET 
  6988.       PSNS_INVALID_CONFIGURATION 
  6989.       PSNS_IN_USE 
  6990.       PSNS_TRANSFERRED_OUT 
  6991.       PSNS_INVALID_KEYWORD 
  6992.       PSNS_INVALID_VALUE 
  6993.       PSNS_SYNTAX_ERROR 
  6994.       PSNS_INCOMPLETE_STRING 
  6995.       PSNS_SEMANTIC_ERROR 
  6996.       REXX_INVALID_HANDLE 
  6997.  
  6998.  
  6999. ΓòÉΓòÉΓòÉ <hidden> PsnsSetBackupSetConfig - Remarks ΓòÉΓòÉΓòÉ
  7000.  
  7001. Use this function to set the configuration information for a backup set. The 
  7002. format of this information depends on the storage device which the backup set 
  7003. uses; to find out how all the standard OS/2 Warp Server Backup/Restore storage 
  7004. devices handle this, see Storage Device Configuration. 
  7005.  
  7006. setName, configString and incConfigString are in quotes to ensure that their 
  7007. cases are correct. 
  7008.  
  7009.  
  7010. ΓòÉΓòÉΓòÉ <hidden> PsnsSetBackupSetConfig - Related functions ΓòÉΓòÉΓòÉ
  7011.  
  7012.      PsnsGetBackupSetConfig 
  7013.  
  7014.      PsnsGetStorageDeviceConfig 
  7015.  
  7016.      PsnsSetStorageDeviceConfig 
  7017.  
  7018.      PsnsTransferIn 
  7019.  
  7020.  
  7021. ΓòÉΓòÉΓòÉ 4.78. PsnsSetStorageDeviceConfig ΓòÉΓòÉΓòÉ
  7022.  
  7023. Select an item 
  7024.  
  7025.      Syntax 
  7026.      Parameters 
  7027.      Returns 
  7028.      Remarks 
  7029.      Example 
  7030.      Related functions 
  7031.  
  7032.  
  7033. ΓòÉΓòÉΓòÉ <hidden> PsnsSetStorageDeviceConfig - Syntax ΓòÉΓòÉΓòÉ
  7034.  
  7035. /****************************************************/
  7036. /* This function sets the configuration information */
  7037. /* for a storage device.                           */
  7038. /****************************************************/
  7039.  
  7040. Call PsnsSetStorageDeviceConfig handle, "deviceName",
  7041.                                 "configString"
  7042.  
  7043.  
  7044. ΓòÉΓòÉΓòÉ <hidden> PsnsSetStorageDeviceConfig - Parameters ΓòÉΓòÉΓòÉ
  7045.  
  7046.  handle 
  7047.            Handle returned by PsnsInit 
  7048.  
  7049.  "deviceName" 
  7050.            The name of the storage device to configure. 
  7051.  
  7052.  "configString" 
  7053.            Configuration string for the storage device. The format of this 
  7054.            string depends on the storage device type. 
  7055.  
  7056.  
  7057. ΓòÉΓòÉΓòÉ <hidden> PsnsSetStorageDeviceConfig - Returns ΓòÉΓòÉΓòÉ
  7058.  
  7059.       PSNS_OK 
  7060.       PSNS_HANDLE_IN_USE 
  7061.       PSNS_COMMUNICATIONS_ERROR 
  7062.       PSNS_INVALID_HANDLE 
  7063.       PSNS_INVALID_STORAGE_DEVICE 
  7064.       PSNS_INVALID_CONFIGURATION 
  7065.       PSNS_IN_USE 
  7066.       PSNS_NOT_CONFIGURABLE 
  7067.       PSNS_INVALID_KEYWORD 
  7068.       PSNS_INVALID_VALUE 
  7069.       PSNS_SYNTAX_ERROR 
  7070.       PSNS_INCOMPLETE_STRING 
  7071.       PSNS_SEMANTIC_ERROR 
  7072.       REXX_INVALID_HANDLE 
  7073.  
  7074.  
  7075. ΓòÉΓòÉΓòÉ <hidden> PsnsSetStorageDeviceConfig - Remarks ΓòÉΓòÉΓòÉ
  7076.  
  7077. Use this function to set the configuration information for a device. The only 
  7078. storage device currently changeable using this command is ADSM. The format of 
  7079. this information depends on the storage device; to find out how all the 
  7080. standard OS/2 Warp Server Backup/Restore storage devices handle this, see 
  7081. Storage Device Configuration. 
  7082.  
  7083. deviceName and configString are in quotes to ensure that their cases are 
  7084. correct. 
  7085.  
  7086.  
  7087. ΓòÉΓòÉΓòÉ <hidden> PsnsSetStorageDeviceConfig - Related functions ΓòÉΓòÉΓòÉ
  7088.  
  7089.      PsnsGetBackupSetConfig 
  7090.  
  7091.      PsnsGetStorageDeviceConfig 
  7092.  
  7093.      PsnsSetBackupSetConfig 
  7094.  
  7095.  
  7096. ΓòÉΓòÉΓòÉ 4.79. PsnsSettingsInfo ΓòÉΓòÉΓòÉ
  7097.  
  7098. Select an item 
  7099.  
  7100.      Syntax 
  7101.      Parameters 
  7102.      Returns 
  7103.      Remarks 
  7104.      Example 
  7105.      Related functions 
  7106.  
  7107.  
  7108. ΓòÉΓòÉΓòÉ <hidden> PsnsSettingsInfo - Syntax ΓòÉΓòÉΓòÉ
  7109.  
  7110. /***************************************************/
  7111. /* This function sets many of the general options. */
  7112. /***************************************************/
  7113.  
  7114. Call PsnsSettingsInfo handle, "stemname"
  7115.  
  7116.  
  7117. ΓòÉΓòÉΓòÉ <hidden> PsnsSettingsInfo - Parameters ΓòÉΓòÉΓòÉ
  7118.  
  7119.  handle 
  7120.            Handle returned by PsnsInit 
  7121.  
  7122.  "stemname" 
  7123.            The name of the stem into which the information to be changed has 
  7124.            been put. 
  7125.  
  7126.            Stemname parameters which may be used are: 
  7127.  
  7128.                                0manualPriority
  7129.                     Possible values are: 
  7130.  
  7131.                     NORMAL     Normal priority for manual backups. 
  7132.                     HIGH       High priority for manual backups. 
  7133.  
  7134.                                0autoPriority
  7135.                     Possible values are: 
  7136.  
  7137.                     NORMAL     Normal priority for automatic backups. 
  7138.                     HIGH       High priority for automatic backups. 
  7139.  
  7140.                                0tempPath
  7141.                     Path for temporary files. 
  7142.  
  7143.                                0flags
  7144.                     A binary string representing the following on/off flags: 
  7145.  
  7146.                     SET_LOG 
  7147.                              Enable logging for backup, restore and drop 
  7148.                              activities. 
  7149.                     SET_LOG_SUCCESSES 
  7150.                              Log individual files which are successful. 
  7151.                     SET_LOG_FAILURES 
  7152.                              Log individual files which fail. 
  7153.                     SET_BACKUP_EXIT 
  7154.                              Enable the user exit on backup. 
  7155.                     SET_RESTORE_EXIT 
  7156.                              Enable the user exit on restore. 
  7157.  
  7158.                     Note:  The first flag, SET_LOG, is represented by the least 
  7159.                     significant bit of the string (the right-most digit 00001); 
  7160.                     the second flag, SET_LOG_SUCCESSES, is represented by the 
  7161.                     next least significant bit of the string (the second digit 
  7162.                     from the right 00010), and so on. A bit set to one 
  7163.                     indicates the flag is set to true, a bit set to zero 
  7164.                     indicates false. 
  7165.  
  7166.                                0logFileLimit
  7167.                     Maximum number of lines in a log file; if this is 0 then 
  7168.                     there is no limit to the size of a log file. 
  7169.  
  7170.                                0backupExit
  7171.                     The name of a REXX command file to run on backup. 
  7172.  
  7173.                                0restoreExit
  7174.                     The name of a REXX command file to run on restore. 
  7175.  
  7176.                                0enableACLBackup
  7177.                     Possible values are: 
  7178.  
  7179.                     1      Back up and restore Access Control Lists using 
  7180.                            BACKACC and RESTACC. 
  7181.                     0      Do not back up and restore Access Control Lists. 
  7182.  
  7183.                                0uadFilename
  7184.                     The name of the file which contains the User Accounts 
  7185.                     Database, usually NET.ACC. 
  7186.  
  7187.  For more information on REXX user exits and on backing up Access Control 
  7188.  Lists, see the OS/2 Warp Server Backup/Restore online help. 
  7189.  
  7190.  
  7191. ΓòÉΓòÉΓòÉ <hidden> PsnsSettingsInfo - Returns ΓòÉΓòÉΓòÉ
  7192.  
  7193.       PSNS_OK 
  7194.       PSNS_HANDLE_IN_USE 
  7195.       PSNS_COMMUNICATIONS_ERROR 
  7196.       PSNS_INVALID_HANDLE 
  7197.       PSNS_INVALID_PRIORITY 
  7198.       PSNS_INVALID_PATH 
  7199.       PSNS_INVALID_FLAGS 
  7200.       PSNS_INVALID_MASK 
  7201.       REXX_INVALID_HANDLE 
  7202.       REXX_INVALID_MASK_NAME 
  7203.  
  7204.  
  7205. ΓòÉΓòÉΓòÉ <hidden> PsnsSettingsInfo - Remarks ΓòÉΓòÉΓòÉ
  7206.  
  7207. Use this function to change the following settings: 
  7208.  
  7209.      Priority of backup and restore threads 
  7210.      Path for temporary files 
  7211.      Log file options 
  7212.      User exits 
  7213.  
  7214.  Putting in a parameter means that it will be changed, from its old value. To 
  7215.  look at the current settings, use PsnsListSettings. 
  7216.  
  7217.  stemname is in quotes to ensure that its case is correct. 
  7218.  
  7219.  
  7220. ΓòÉΓòÉΓòÉ <hidden> PsnsSettingsInfo - Related functions ΓòÉΓòÉΓòÉ
  7221.  
  7222.      PsnsDefaultsInfo 
  7223.  
  7224.      PsnsListDefaults 
  7225.  
  7226.      PsnsListSettings 
  7227.  
  7228.  
  7229. ΓòÉΓòÉΓòÉ 4.80. PsnsSourceDriveType ΓòÉΓòÉΓòÉ
  7230.  
  7231. Select an item 
  7232.  
  7233.      Syntax 
  7234.      Parameters 
  7235.      Returns 
  7236.      Remarks 
  7237.      Example 
  7238.      Related functions 
  7239.  
  7240.  
  7241. ΓòÉΓòÉΓòÉ <hidden> PsnsSourceDriveType - Syntax ΓòÉΓòÉΓòÉ
  7242.  
  7243. /****************************************************/
  7244. /* This function sets the type of a source drive    */
  7245. /****************************************************/
  7246.  
  7247. Call PsnsSourceDriveType handle, "drive", "driveType"
  7248.  
  7249.  
  7250. ΓòÉΓòÉΓòÉ <hidden> PsnsSourceDriveType - Parameters ΓòÉΓòÉΓòÉ
  7251.  
  7252.  handle 
  7253.            Handle returned by PsnsInit 
  7254.  
  7255.  "drive" 
  7256.            The drive letter of the source drive to change. 
  7257.  
  7258.  "driveType" 
  7259.            New type for the source drive. Possible values are: 
  7260.  
  7261.            HARDDISK 
  7262.                     A hard disk drive. 
  7263.            DISKETTE 
  7264.                     A floppy disk drive. 
  7265.            LANDRIVE 
  7266.                     A lan drive. 
  7267.            OPTICAL 
  7268.                     A read-write optical drive. 
  7269.            CDROM 
  7270.                     A CD-Rom drive. 
  7271.            REMOVABLE 
  7272.                     A removable drive 
  7273.            OTHER 
  7274.                     Some other type of drive. 
  7275.  
  7276.  
  7277. ΓòÉΓòÉΓòÉ <hidden> PsnsSourceDriveType - Returns ΓòÉΓòÉΓòÉ
  7278.  
  7279.       PSNS_OK 
  7280.       PSNS_HANDLE_IN_USE 
  7281.       PSNS_COMMUNICATIONS_ERROR 
  7282.       PSNS_INVALID_HANDLE 
  7283.       PSNS_INVALID_DRIVE_TYPE 
  7284.       REXX_INVALID_HANDLE 
  7285.       REXX_INVALID_PARAMETER 
  7286.  
  7287.  
  7288. ΓòÉΓòÉΓòÉ <hidden> PsnsSourceDriveType - Remarks ΓòÉΓòÉΓòÉ
  7289.  
  7290. Use this function to tell OS/2 Warp Server Backup/Restore what type of drive a 
  7291. particular source drive is. Usually this should be detected automatically but 
  7292. this call allows the user to override the automatic detection. 
  7293.  
  7294. drive and driveType are in quotes to ensure that their cases are correct. 
  7295.  
  7296.  
  7297. ΓòÉΓòÉΓòÉ <hidden> PsnsSourceDriveType - Related functions ΓòÉΓòÉΓòÉ
  7298.  
  7299.      PsnsListSourceDrives 
  7300.  
  7301.      PsnsRefreshSourceDrives 
  7302.  
  7303.      PsnsSelectSourceDrive 
  7304.  
  7305.  
  7306. ΓòÉΓòÉΓòÉ 4.81. PsnsStorageDeviceInfo ΓòÉΓòÉΓòÉ
  7307.  
  7308. Select an item 
  7309.  
  7310.      Syntax 
  7311.      Parameters 
  7312.      Returns 
  7313.      Remarks 
  7314.      Example 
  7315.      Related functions 
  7316.  
  7317.  
  7318. ΓòÉΓòÉΓòÉ <hidden> PsnsStorageDeviceInfo - Syntax ΓòÉΓòÉΓòÉ
  7319.  
  7320. /****************************************************/
  7321. /* This function gets all the information about a   */
  7322. /* storage device                                   */
  7323. /****************************************************/
  7324.  
  7325. Call PsnsStorageDeviceInfo handle, "stemname"
  7326.  
  7327.  
  7328. ΓòÉΓòÉΓòÉ <hidden> PsnsStorageDeviceInfo - Parameters ΓòÉΓòÉΓòÉ
  7329.  
  7330.  handle 
  7331.            Handle returned by PsnsInit 
  7332.  
  7333.  "stemname" 
  7334.            The name of the stem from which information is to be taken and/or 
  7335.            put into. 
  7336.  
  7337.            Stemname parameters which may be used are: 
  7338.  
  7339.                                0name
  7340.                     The name of the storage device. This is always required. 
  7341.  
  7342.                                0dllName
  7343.                     The name of the Dynamic Link Library (DLL) which implements 
  7344.                     the storage device. 
  7345.  
  7346.  
  7347. ΓòÉΓòÉΓòÉ <hidden> PsnsStorageDeviceInfo - Returns ΓòÉΓòÉΓòÉ
  7348.  
  7349.       PSNS_OK 
  7350.       PSNS_HANDLE_IN_USE 
  7351.       PSNS_COMMUNICATIONS_ERROR 
  7352.       PSNS_INVALID_HANDLE 
  7353.       PSNS_INVALID_STORAGE_DEVICE 
  7354.       PSNS_INVALID_MASK 
  7355.       PSNS_IN_USE 
  7356.       REXX_INVALID_HANDLE 
  7357.  
  7358.  
  7359. ΓòÉΓòÉΓòÉ <hidden> PsnsStorageDeviceInfo - Remarks ΓòÉΓòÉΓòÉ
  7360.  
  7361. Use this function to get information about a storage device. The information is 
  7362. returned in terms of compound variables, taking the stemname specified, and a 
  7363. tail added by the program. The compound variables are listed in the parameters 
  7364. section. 
  7365.  
  7366. stemname is in quotes to ensure that its case is correct. 
  7367.  
  7368.  
  7369. ΓòÉΓòÉΓòÉ <hidden> PsnsStorageDeviceInfo - Related functions ΓòÉΓòÉΓòÉ
  7370.  
  7371.      PsnsCreateStorageDevice 
  7372.  
  7373.      PsnsDeleteStorageDevice 
  7374.  
  7375.      PsnsGetStorageDeviceConfig 
  7376.  
  7377.      PsnsListCreatableStorageDevices 
  7378.  
  7379.      PsnsListStorageDevices 
  7380.  
  7381.      PsnsRefreshStorageDevices 
  7382.  
  7383.      PsnsSetStorageDeviceConfig 
  7384.  
  7385.  
  7386. ΓòÉΓòÉΓòÉ 4.82. PsnsTerm ΓòÉΓòÉΓòÉ
  7387.  
  7388. Select an item 
  7389.  
  7390.      Syntax 
  7391.      Parameters 
  7392.      Returns 
  7393.      Remarks 
  7394.      Example 
  7395.      Related functions 
  7396.  
  7397.  
  7398. ΓòÉΓòÉΓòÉ <hidden> PsnsTerm - Syntax ΓòÉΓòÉΓòÉ
  7399.  
  7400. /***************************************************/
  7401. /* This function terminates an API session and     */
  7402. /* frees the API handle.                           */
  7403. /***************************************************/
  7404.  
  7405. Call PsnsTerm handle
  7406.  
  7407.  
  7408. ΓòÉΓòÉΓòÉ <hidden> PsnsTerm - Parameters ΓòÉΓòÉΓòÉ
  7409.  
  7410.  handle 
  7411.            Handle returned by PsnsInit 
  7412.  
  7413.  
  7414. ΓòÉΓòÉΓòÉ <hidden> PsnsTerm - Returns ΓòÉΓòÉΓòÉ
  7415.  
  7416.       PSNS_OK 
  7417.       PSNS_COMMUNICATIONS_ERROR 
  7418.       PSNS_HANDLE_IN_USE 
  7419.       PSNS_INVALID_HANDLE 
  7420.       REXX_INVALID_HANDLE 
  7421.  
  7422.  
  7423. ΓòÉΓòÉΓòÉ <hidden> PsnsTerm - Remarks ΓòÉΓòÉΓòÉ
  7424.  
  7425. This function should be called whenever you have finished with a handle which 
  7426. was obtained using PsnsInit 
  7427.  
  7428.  
  7429. ΓòÉΓòÉΓòÉ <hidden> PsnsTerm - Related functions ΓòÉΓòÉΓòÉ
  7430.  
  7431.      PsnsInit 
  7432.  
  7433.  
  7434. ΓòÉΓòÉΓòÉ 4.83. PsnsTransferBackupSet ΓòÉΓòÉΓòÉ
  7435.  
  7436. Select an item 
  7437.  
  7438.      Syntax 
  7439.      Parameters 
  7440.      Returns 
  7441.      Remarks 
  7442.      Example 
  7443.      Related functions 
  7444.  
  7445.  
  7446. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferBackupSet - Syntax ΓòÉΓòÉΓòÉ
  7447.  
  7448. /****************************************************/
  7449. /* This function transfers a backup set in or out   */
  7450. /****************************************************/
  7451.  
  7452. Call PsnsTransferBackupSet handle, "backupSetName",
  7453.                            "action", "base"
  7454.  
  7455.  
  7456. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferBackupSet - Parameters ΓòÉΓòÉΓòÉ
  7457.  
  7458.  handle 
  7459.            Handle returned by PsnsInit 
  7460.  
  7461.  "backupSetName" 
  7462.            The name of the backup set to transfer in or out 
  7463.  
  7464.  "action" 
  7465.            Possible values are: 
  7466.  
  7467.            IN     Transfer the backup set in 
  7468.            OUT    Transfer the backup set out 
  7469.  
  7470.  "base" 
  7471.            This parameter is only used when transferring out a dual device 
  7472.            backup set. It is omitted for single device backup sets and when 
  7473.            transferring in. Possible values are: 
  7474.  
  7475.            BASE   Transfer out to the base storage device. 
  7476.            INC    Transfer out to the incremental storage device. 
  7477.  
  7478.  
  7479. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferBackupSet - Returns ΓòÉΓòÉΓòÉ
  7480.  
  7481.       PSNS_OK 
  7482.       PSNS_HANDLE_IN_USE 
  7483.       PSNS_COMMUNICATIONS_ERROR 
  7484.       PSNS_INVALID_HANDLE 
  7485.       PSNS_INVALID_BACKUP_SET 
  7486.       PSNS_TRANSFERRED_OUT 
  7487.       PSNS_TRANSFERRED_IN 
  7488.       REXX_INVALID_HANDLE 
  7489.       REXX_INVALID_PARAMETER 
  7490.  
  7491.  
  7492. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferBackupSet - Remarks ΓòÉΓòÉΓòÉ
  7493.  
  7494. Use this function to transfer out or transfer in a backup set. When a backup 
  7495. set is transferred out, you cannot use it for backing up or restoring, but you 
  7496. can take it to another computer and transfer it in to use the data on it. 
  7497. Transferring out ensures that all indexing information stored on the backup set 
  7498. media is up to date. It is only necessary to specify all the parameters when 
  7499. transferring out a dual device backup set. In all other cases, the last 
  7500. parameter is omitted. 
  7501.  
  7502. backupSetName, action and base are in quotes to ensure that their cases are 
  7503. correct. 
  7504.  
  7505.  
  7506. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferBackupSet - Related functions ΓòÉΓòÉΓòÉ
  7507.  
  7508.      PsnsBackupSetInfo 
  7509.  
  7510.      PsnsCreateBackupSet 
  7511.  
  7512.      PsnsDeleteBackupSet 
  7513.  
  7514.      PsnsEmptyBackupSet 
  7515.  
  7516.      PsnsGetBackupSetConfig 
  7517.  
  7518.      PsnsGetLogFile 
  7519.  
  7520.      PsnsListBackupSets 
  7521.  
  7522.      PsnsSetBackupSetConfig 
  7523.  
  7524.      PsnsTransferIn 
  7525.  
  7526.  
  7527. ΓòÉΓòÉΓòÉ 4.84. PsnsTransferIn ΓòÉΓòÉΓòÉ
  7528.  
  7529. Select an item 
  7530.  
  7531.      Syntax 
  7532.      Parameters 
  7533.      Returns 
  7534.      Remarks 
  7535.      Example 
  7536.      Related functions 
  7537.  
  7538.  
  7539. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferIn - Syntax ΓòÉΓòÉΓòÉ
  7540.  
  7541. /****************************************************/
  7542. /* This function transfers in a backup set from a   */
  7543. /* storage device.                                  */
  7544. /****************************************************/
  7545.  
  7546. Call PsnsTransferIn handle, "storageDevice", "backupsetName"
  7547.  
  7548.  
  7549. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferIn - Parameters ΓòÉΓòÉΓòÉ
  7550.  
  7551.  handle 
  7552.            Handle returned by PsnsInit 
  7553.  
  7554.  "storageDevice" 
  7555.            Name of the storage device from which to transfer in 
  7556.  
  7557.  "backupsetName" 
  7558.            The name of the backup set to transfer in 
  7559.  
  7560.  
  7561. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferIn - Returns ΓòÉΓòÉΓòÉ
  7562.  
  7563.       PSNS_OK 
  7564.       PSNS_HANDLE_IN_USE 
  7565.       PSNS_COMMUNICATIONS_ERROR 
  7566.       PSNS_INVALID_HANDLE 
  7567.       PSNS_INVALID_STORAGE_DEVICE 
  7568.       PSNS_IN_USE 
  7569.       REXX_INVALID_HANDLE 
  7570.  
  7571.  
  7572. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferIn - Remarks ΓòÉΓòÉΓòÉ
  7573.  
  7574. Use this function to transfer in a backup set which OS/2 Warp Server 
  7575. Backup/Restore does not know about. This function reads all the indexing 
  7576. information off the backup set media and creates a new backup set which refers 
  7577. to it. To see the name of this new backup set use the function 
  7578. PsnsListBackupSets. 
  7579.  
  7580. storageDevice and backupsetName are in quotes to ensure that their cases are 
  7581. correct. 
  7582.  
  7583.  
  7584. ΓòÉΓòÉΓòÉ <hidden> PsnsTransferIn - Related functions ΓòÉΓòÉΓòÉ
  7585.  
  7586.      PsnsBackupSetInfo 
  7587.  
  7588.      PsnsCreateBackupSet 
  7589.  
  7590.      PsnsDeleteBackupSet 
  7591.  
  7592.      PsnsEmptyBackupSet 
  7593.  
  7594.      PsnsGetBackupSetConfig 
  7595.  
  7596.      PsnsGetLogFile 
  7597.  
  7598.      PsnsListBackupSets 
  7599.  
  7600.      PsnsSetBackupSetConfig 
  7601.  
  7602.      PsnsTransferBackupSet 
  7603.  
  7604.  
  7605. ΓòÉΓòÉΓòÉ 4.85. PsnsVolumeInfo ΓòÉΓòÉΓòÉ
  7606.  
  7607. Select an item 
  7608.  
  7609.      Syntax 
  7610.      Parameters 
  7611.      Returns 
  7612.      Remarks 
  7613.      Example 
  7614.      Related functions 
  7615.  
  7616.  
  7617. ΓòÉΓòÉΓòÉ <hidden> PsnsVolumeInfo - Syntax ΓòÉΓòÉΓòÉ
  7618.  
  7619. /***************************************************/
  7620. /* This function gets all the information about a  */
  7621. /* volume                                          */
  7622. /***************************************************/
  7623.  
  7624. Call PsnsVolumeInfo handle, "stemname", volumeID
  7625.  
  7626.  
  7627. ΓòÉΓòÉΓòÉ <hidden> PsnsVolumeInfo - Parameters ΓòÉΓòÉΓòÉ
  7628.  
  7629.  handle 
  7630.            Handle returned by PsnsInit 
  7631.  
  7632.  "stemname" 
  7633.            The name of the stem into which the information is to be put. 
  7634.  
  7635.            Stemname parameter values returned are: 
  7636.  
  7637.                                0id
  7638.                     The volume ID 
  7639.  
  7640.                                0name
  7641.                     The name of the volume 
  7642.  
  7643.                                0storageDevice
  7644.                     The storage device used by the volume 
  7645.  
  7646.                                0transferredOut
  7647.                     Whether or not the volume has been transferred out; 
  7648.                     possible values are: 
  7649.  
  7650.                     1      The volume belongs to a backup set that has been 
  7651.                            transferred out. 
  7652.                     0      The volume belongs to a backup set that has not been 
  7653.                            transferred out. 
  7654.  
  7655.                                0available
  7656.                     Whether or not the volume is available for use; possible 
  7657.                     values are: 
  7658.  
  7659.                     1      The volume is available for use. 
  7660.                     0      The user has made the volume unavailable and it will 
  7661.                            not be used for backing up or restoring data. 
  7662.  
  7663.                                0backupSets
  7664.                     The number of backup sets which use this volume 
  7665.  
  7666.                                0unitMultiplier
  7667.                     This specifies the units in which the volume usage 
  7668.                     information is specified. It is a number in bytes, for 
  7669.                     example, 1024 for kilobytes. 
  7670.  
  7671.                                0totalCapacity
  7672.                     Total size of the volume in units of unitMultiplier 
  7673.  
  7674.                                0psnsCapacity
  7675.                     The amount of space on the volume, in units of 
  7676.                     unitMultiplier which is available for OS/2 Warp Server 
  7677.                     Backup/Restore to use. 
  7678.  
  7679.                                0psnsUsed
  7680.                     Amount of space currently used on the volume by OS/2 Warp 
  7681.                     Server Backup/Restore in units of unitMultiplier. 
  7682.  
  7683.                                0psnsFree
  7684.                     Amount of free space on the volume, in units of 
  7685.                     unitMultiplier which OS/2 Warp Server Backup/Restore may 
  7686.                     use. 
  7687.  
  7688.                                0otherFree
  7689.                     Amount of free space on the volume, in units of 
  7690.                     unitMultiplier which OS/2 Warp Server Backup/Restore may 
  7691.                     not use. 
  7692.  
  7693.                                0totalBad
  7694.                     Total amount of unusable space on the volume, in units of 
  7695.                     unitMultiplier 
  7696.  
  7697.                                0backupSet
  7698.                     If the volume is used for only one backup set, this 
  7699.                     contains the name of that backup set 
  7700.  
  7701.                                0indexNo
  7702.                     If the volume is used for only one backup set, this 
  7703.                     contains the index of the volume within the backup set. A 
  7704.                     negative value signifies that the volume is an index 
  7705.                     diskette. A value of zero means that the volume is 
  7706.                     unassociated or fixed. 
  7707.  
  7708.  volumeID 
  7709.            The ID of the volume to be inspected. 
  7710.  
  7711.  
  7712. ΓòÉΓòÉΓòÉ <hidden> PsnsVolumeInfo - Returns ΓòÉΓòÉΓòÉ
  7713.  
  7714.       PSNS_OK 
  7715.       PSNS_HANDLE_IN_USE 
  7716.       PSNS_COMMUNICATIONS_ERROR 
  7717.       PSNS_INVALID_HANDLE 
  7718.       PSNS_INVALID_VOLUME 
  7719.       PSNS_IN_USE 
  7720.       PSNS_INVALID_MASK 
  7721.       REXX_INVALID_HANDLE 
  7722.  
  7723.  
  7724. ΓòÉΓòÉΓòÉ <hidden> PsnsVolumeInfo - Remarks ΓòÉΓòÉΓòÉ
  7725.  
  7726. Use this function to get information about a volume. The information is 
  7727. returned in terms of compound variables, taking the stemname specified, and a 
  7728. tail added by the program. The compound variables are listed in the parameters 
  7729. section. 
  7730.  
  7731. stemname is in quotes to ensure that its case is correct. 
  7732.  
  7733.  
  7734. ΓòÉΓòÉΓòÉ <hidden> PsnsVolumeInfo - Related functions ΓòÉΓòÉΓòÉ
  7735.  
  7736.      PsnsActivateVolume 
  7737.  
  7738.      PsnsAssociateVolume 
  7739.  
  7740.      PsnsCreateVolume 
  7741.  
  7742.      PsnsDeleteVolume 
  7743.  
  7744.      PsnsListVolumeBackupSets 
  7745.  
  7746.      PsnsListVolumes 
  7747.  
  7748.  
  7749. ΓòÉΓòÉΓòÉ 5. Errors ΓòÉΓòÉΓòÉ
  7750.  
  7751.  0  PSNS_OK 
  7752.            No errors occurred. 
  7753.  
  7754.  1  PSNS_NO_MORE_HANDLES 
  7755.            Too many list handles are in use and a new one cannot be allocated. 
  7756.  
  7757.  3  PSNS_UNKNOWN_ERROR 
  7758.            An unknown internal error occurred. 
  7759.  
  7760.  4  PSNS_HANDLE_IN_USE 
  7761.            An API call is already in progress using this handle.  You may not 
  7762.            call more than one API function at the same time with the same 
  7763.            handle; if another thread needs to call API functions, it should 
  7764.            obtain a new handle using PsnsInit. 
  7765.  
  7766.  5  PSNS_ALREADY_EXISTS 
  7767.            You are trying to create, copy or rename an object, but the name you 
  7768.            have specified already exists. 
  7769.  
  7770.  6  PSNS_ARCHIVE_ERROR 
  7771.            An internal error was encountered when processing index files. 
  7772.  
  7773.  7  PSNS_INVALID_HANDLE 
  7774.            The handle you have passed is not one which was returned by 
  7775.            PsnsInit. 
  7776.  
  7777.  8  PSNS_INVALID_LIST_HANDLE 
  7778.            The list handle you have passed to a listing function is not known. 
  7779.  
  7780.  9  PSNS_INVALID_PARAMETER 
  7781.            A parameter passed to an API function is invalid, for example a 
  7782.            pointer is NULL when it shouldn't be. 
  7783.  
  7784.  10  PSNS_INVALID_BACKUP_METHOD 
  7785.            The named backup method does not exist. 
  7786.  
  7787.  11  PSNS_INVALID_VOLUME 
  7788.            The given volume ID does not exist. 
  7789.  
  7790.  12  PSNS_INVALID_EVENT_TYPE 
  7791.            The given event type is not a valid one.  Look in PsnsCreateEvent to 
  7792.            see a list of valid types. 
  7793.  
  7794.  13  PSNS_INVALID_EVENT_OPTION 
  7795.            The given event option is not defined. 
  7796.  
  7797.  14  PSNS_INVALID_MASK 
  7798.            The mask you have supplied does not make sense, for example, 
  7799.            searching for files which are both larger and smaller than 10kB. 
  7800.  
  7801.  15  PSNS_INVALID_DRIVE_TYPE 
  7802.            The given drive type is not one defined in PsnsSourceDriveType. 
  7803.  
  7804.  16  PSNS_INVALID_GENERATIONS 
  7805.            The number of generations you have specified is not allowed; the 
  7806.            number of generations must be between 1 and 250. 
  7807.  
  7808.  17  PSNS_INVALID_RULEBOOK 
  7809.            The named rulebook does not exist. 
  7810.  
  7811.  18  PSNS_INVALID_FILE_FILTER 
  7812.            The named file filter does not exist. 
  7813.  
  7814.  19  PSNS_INVALID_BACKUP_SET 
  7815.            The named backup set does not exist. 
  7816.  
  7817.  20  PSNS_INVALID_RESTORE_METHOD 
  7818.            The named restore method does not exist. 
  7819.  
  7820.  21  PSNS_INVALID_SOURCE_DRIVE 
  7821.            You gave an invalid character for a source drive letter. 
  7822.  
  7823.  22  PSNS_INVALID_POSITION 
  7824.            The position you referred to in a rule or file filter is out of 
  7825.            range. 
  7826.  
  7827.  23  PSNS_INVALID_EVENT 
  7828.            The given event ID does not exist. 
  7829.  
  7830.  24  PSNS_INVALID_DRIVE 
  7831.            The specified drive is not a valid drive letter. 
  7832.  
  7833.  25  PSNS_INVALID_PATH 
  7834.            The specified path is not valid. 
  7835.  
  7836.  26  PSNS_INVALID_FILENAME 
  7837.            The specified filename is not valid. 
  7838.  
  7839.  27  PSNS_ALREADY_ASSOCIATED 
  7840.            The volume is already associated with a backup set. 
  7841.  
  7842.  28  PSNS_INVALID_NAME 
  7843.            The name you gave when creating, copying or renaming an object is 
  7844.            not valid. See object names for a description of what constitutes a 
  7845.            valid object name. 
  7846.  
  7847.  29  PSNS_INVALID_FILE_FILTER_TYPE 
  7848.            The given file filter type is not one defined in 
  7849.            PsnsCreateFileFilter. 
  7850.  
  7851.  30  PSNS_INVALID_STORAGE_DEVICE_TYPE 
  7852.            The given storage device type does not exist as a creatable storage 
  7853.            device type. 
  7854.  
  7855.  31  PSNS_INVALID_STORAGE_DEVICE 
  7856.            The named storage device does not exist. 
  7857.  
  7858.  32  PSNS_IN_USE 
  7859.            You tried to delete or change an object which is currently in use 
  7860.            and therefore cannot be deleted or changed. 
  7861.  
  7862.  33  PSNS_CANNOT_DELETE 
  7863.            You tried to delete a storage device or volume which may not be 
  7864.            deleted. 
  7865.  
  7866.  34  PSNS_FILE_NOT_FOUND 
  7867.            The named file was not found in the backup set. 
  7868.  
  7869.  35  PSNS_INVALID_TIME 
  7870.            The time you specified for an event is not valid. 
  7871.  
  7872.  36  PSNS_NO_EVENTS 
  7873.            There are no events currently scheduled. 
  7874.  
  7875.  37  PSNS_TOO_MUCH_DATA 
  7876.            The buffer you supplied is not large enough to receive all the data 
  7877.            which would be returned; the data has been truncated to fit in the 
  7878.            buffer. 
  7879.  
  7880.  38  PSNS_CANT_CONNECT 
  7881.            An error occurred when trying to connect to the API server. 
  7882.  
  7883.  39  PSNS_INVALID_CONFIGURATION 
  7884.            The configuration string you gave for a storage device or backup 
  7885.            method is not valid. 
  7886.  
  7887.  40  PSNS_INVALID_PRIORITY 
  7888.            The given priority is not valid, it must have a value of 1 for 
  7889.            normal priority, or 2 for high priority. 
  7890.  
  7891.  41  PSNS_INVALID_GENERATION 
  7892.            The generation you specified does not exist. 
  7893.  
  7894.  42  PSNS_TRANSFERRED_IN 
  7895.            The backup set was already transferred in. 
  7896.  
  7897.  43  PSNS_TRANSFERRED_OUT 
  7898.            The backup set was already transferred out, or you tried to perform 
  7899.            an operation using a backup set which is transferred out. 
  7900.  
  7901.  44  PSNS_INVALID_COMPRESSION 
  7902.            The specified compression option is not valid. 
  7903.  
  7904.  45  PSNS_MALFORMED_METHOD 
  7905.            Some options in the backup or restore method are not compatible with 
  7906.            each other, 
  7907.  
  7908.  46  PSNS_INVALID_DATE 
  7909.            The given date is not valid. 
  7910.  
  7911.  47  PSNS_READONLY 
  7912.            You tried to change a rule which cannot be changed. 
  7913.  
  7914.  48  PSNS_NOT_CONFIGURABLE 
  7915.            The backup set or storage device configuration cannot be changed 
  7916.            now. 
  7917.  
  7918.  49  PSNS_INVALID_FLAGS 
  7919.            The flags you specified in PsnsSettingsInfo are not valid. 
  7920.  
  7921.  50  PSNS_COMMUNICATIONS_ERROR 
  7922.            Contact with the API server has been lost; all handles to that 
  7923.            server have been closed. 
  7924.  
  7925.  51  PSNS_INVALID_RC 
  7926.            The return code passed to PsnsGetMessageText is not valid. 
  7927.  
  7928.  52  PSNS_INDEX_DISKETTE 
  7929.            The volume ID passed to PsnsActivateVolume is that of an index 
  7930.            diskette. The active state of index diskettes cannot be altered in 
  7931.            this way. 
  7932.  
  7933.  53  PSNS_FIXED_VOLUME 
  7934.            An API function for working with removable volumes has been passed 
  7935.            the ID of a fixed volume. 
  7936.  
  7937.  54  PSNS_INAPPROPRIATE_BACKUP_SET 
  7938.            The backup set passed to PsnsAssociateVolume is not appropriate for 
  7939.            association with the volume. 
  7940.  
  7941.  55  PSNS_INVALID_KEYWORD 
  7942.            A keyword in a configuration string is incorrect, for example, using 
  7943.            the BEEP keyword with an ADSM storage device. 
  7944.  
  7945.  56  PSNS_INVALID_VALUE 
  7946.            A value in a configuration string is incorrect, for example, a 
  7947.            non-numeric was found where a numeric value was expected. 
  7948.  
  7949.  57  PSNS_SYNTAX_ERROR 
  7950.            A configuration string did not conform to the format described in 
  7951.            Storage Device & Backup Set Configuration. 
  7952.  
  7953.  58  PSNS_INCOMPLETE_STRING 
  7954.            A required parameter was missing from the configuration string. 
  7955.  
  7956.  59  PSNS_SEMANTIC_ERROR 
  7957.            An error occurred whilst processing a configuration string, for 
  7958.            example, a path name is invalid. 
  7959.  
  7960.  60  PSNS_ERROR_DURING_BACKUP 
  7961.            There were errors during the backup. If the logging of failures is 
  7962.            enabled, the backup set log contains details of the errors. 
  7963.  
  7964.  61  PSNS_ERROR_DURING_RESTORE 
  7965.            There were errors during the restore. If the logging of failures is 
  7966.            enabled, the backup set log contains details of the errors. 
  7967.  
  7968.  62  PSNS_UNHANDLED_EXCEPTION 
  7969.            An OS/2 Warp Server Backup/Restore internal error occurred; there 
  7970.            was an unhandled exception. 
  7971.  
  7972.  63  REXX_INVALID_MASK_NAME 
  7973.            The name specified for a mask is invalid, please check with the 
  7974.            parameter definitions to ensure that the correct mask name is being 
  7975.            used. 
  7976.  
  7977.  64  REXX_INVALID_PARAMETER 
  7978.            The value specified for a parameter is an unexpected one, please 
  7979.            check the parameter definitions to ensure that a valid parameter is 
  7980.            used. 
  7981.  
  7982.  65  REXX_INVALID_HANDLE 
  7983.            The handle has not been specified correctly, or has corrupted. 
  7984.            Please check that it has been correctly set up using PsnsInit. 
  7985.  
  7986.  
  7987. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  7988.  
  7989.  /* PSnS REXX example program.                      */
  7990.  
  7991. /***************************************************/
  7992. /* Functions used:                                 */
  7993. /*       PsnsDeleteBackupMethod                    */
  7994. /*       PsnsListBackupMethods                     */
  7995. /*                                                 */
  7996. /* Delete backup methods which don't back up       */
  7997. /* subdirectories.                                 */
  7998. /***************************************************/
  7999.  
  8000. Call RxFuncQuery 'PSNSLOADFUNCS'
  8001. If result = 1 Then Do
  8002.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8003.    If result <> 0 Then Do
  8004.       Say "Could not load the rexxapi dll"
  8005.       Exit
  8006.    End
  8007. End
  8008. Call PSNSLOADFUNCS
  8009.  
  8010. Call PsnsInit 'handle', 'PIPE'
  8011.  
  8012. /* List all the backup methods.                    */
  8013. /* Drop the stem to be used.                       */
  8014. Drop stem.
  8015. Call PsnsListBackupMethods handle, 'stem'
  8016. Say 'PsnsListBackupMethods returned' result
  8017.  
  8018. /* For all the backup methods with the             */
  8019. /* subdirectory flag false, print their name       */
  8020. /* and delete them.                                */
  8021. Do x=1 to stem.0
  8022.    If stem.x.0subdirectories=0 Then Do
  8023.       Say stem.x.0name
  8024.       Call PsnsDeleteBackupMethod handle, stem.x.0name
  8025.    End
  8026. End
  8027.  
  8028. Call PsnsTerm handle
  8029. Exit
  8030.  
  8031.  
  8032. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8033.  
  8034. /* PSnS REXX example program.                      */
  8035.  
  8036. /***************************************************/
  8037. /* Functions used:                                 */
  8038. /*       PsnsBackupMethodInfo                      */
  8039. /*       PsnsCreateBackupMethod                    */
  8040. /*       PsnsEstimateBackupMethod                  */
  8041. /*                                                 */
  8042. /* Create a backup method to back up all changed   */
  8043. /* files on drive D, and find out how many files   */
  8044. /* would be backed up.                             */
  8045. /***************************************************/
  8046.  
  8047. Call RxFuncQuery 'PSNSLOADFUNCS'
  8048. If result = 1 Then Do
  8049.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8050.    If result <> 0 Then Do
  8051.       Say "Could not load the rexxapi dll"
  8052.       Exit
  8053.    End
  8054. End
  8055. Call PSNSLOADFUNCS
  8056.  
  8057. Call PsnsInit 'handle', 'PIPE'
  8058.  
  8059. /* First create a new backup method.               */
  8060. Call PsnsCreateBackupMethod handle, 'Drive D to Pinerry'
  8061. Say 'PsnsCreateBackupMethod returned' result
  8062.  
  8063. /* Set up the backup method to do what we want.    */
  8064. /* Drop the stem to be used.                       */
  8065. Drop methodinfo.
  8066. methodinfo.0name='Drive D to Pinerry'
  8067. methodinfo.0description='Backs up Drive D to backup set Pinerry'
  8068. methodinfo.0subdirectories=1
  8069. methodinfo.0compression=COMPRESSION
  8070. methodinfo.0generations='2'
  8071. methodinfo.0useRulebook=0
  8072. methodinfo.0useFileFilter=0
  8073. methodinfo.0changedFilesOnly=1
  8074. methodinfo.0preview=0
  8075. methodinfo.0backupset='Pinerry'
  8076.  
  8077. Call PsnsBackupMethodInfo handle, 'methodinfo'
  8078. Say 'PsnsBackupMethodInfo returned' result
  8079.  
  8080. /* Estimate the backup method.                     */
  8081. /* Drop the stem to be used.                       */
  8082. Drop estimatestem.
  8083. Call PsnsEstimateBackupMethod handle, 'Drive D to Pinerry', estimatestem
  8084. /* If the estimate was successful, then the data   */
  8085. /* is returned.                                    */
  8086. If result = 0 Then Do
  8087. Say 'Files    Folders'
  8088. Say estimatestem.0files          estimatestem.0folders
  8089. End
  8090.  
  8091. Call PsnsTerm handle
  8092. Exit
  8093.  
  8094.  
  8095. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8096.  
  8097. /* PSnS REXX example program.                      */
  8098.  
  8099. /***************************************************/
  8100. /* Functions used:                                 */
  8101. /*       PsnsRenameBackupMethod                    */
  8102. /*                                                 */
  8103. /* Rename backup method 'Orange' to 'Apple'.       */
  8104. /***************************************************/
  8105.  
  8106. Call RxFuncQuery 'PSNSLOADFUNCS'
  8107. If result = 1 Then Do
  8108.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8109.    If result <> 0 Then Do
  8110.       Say "Could not load the rexxapi dll"
  8111.       Exit
  8112.    End
  8113. End
  8114. Call PSNSLOADFUNCS
  8115.  
  8116. Call PsnsInit 'handle', 'PIPE'
  8117.  
  8118. /* Rename the backup method.                       */
  8119. Call PsnsRenameBackupMethod handle, 'Orange', 'Apple'
  8120. Say 'PsnsRenameBackupMethod returned' result
  8121.  
  8122. Call PsnsTerm handle
  8123. Exit
  8124.  
  8125.  
  8126. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8127.  
  8128. /* PSnS REXX example program.                      */
  8129.  
  8130. /***************************************************/
  8131. /* Functions used:                                 */
  8132. /*       PsnsCopyBackupMethod                      */
  8133. /*                                                 */
  8134. /* Copy backup method 'Tango' to 'Pepsy'.          */
  8135. /***************************************************/
  8136.  
  8137. Call RxFuncQuery 'PSNSLOADFUNCS'
  8138. If result = 1 Then Do
  8139.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8140.    If result <> 0 Then Do
  8141.       Say "Could not load the rexxapi dll"
  8142.       Exit
  8143.    End
  8144. End
  8145. Call PSNSLOADFUNCS
  8146.  
  8147. Call PsnsInit 'handle', 'PIPE'
  8148.  
  8149. /* Copy the backup method.                         */
  8150. Call PsnsCopyBackupMethod handle, 'Tango', 'Pepsy'
  8151. Say 'PsnsCopyBackupMethod returned' result
  8152.  
  8153. Call PsnsTerm handle
  8154. Exit
  8155.  
  8156.  
  8157. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8158.  
  8159. /* PSnS REXX example program.                      */
  8160.  
  8161. /***************************************************/
  8162. /* Functions used:                                 */
  8163. /*       PsnsRunBackupMethod                       */
  8164. /*                                                 */
  8165. /* Runs backup method 'Sage'.                      */
  8166. /***************************************************/
  8167.  
  8168. Call RxFuncQuery 'PSNSLOADFUNCS'
  8169. If result = 1 Then Do
  8170.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8171.    If result <> 0 Then Do
  8172.       Say "Could not load the rexxapi dll"
  8173.       Exit
  8174.    End
  8175. End
  8176. Call PSNSLOADFUNCS
  8177.  
  8178. Call PsnsInit 'handle', 'PIPE'
  8179.  
  8180. /* Run the backup method.                          */
  8181. Call PsnsRunBackupMethod handle, 'Sage'
  8182. Say 'PsnsRunBackupMethod returned' result
  8183.  
  8184. Call PsnsTerm handle
  8185. Exit
  8186.  
  8187.  
  8188. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8189.  
  8190. /* PSnS REXX example program.                      */
  8191.  
  8192. /***************************************************/
  8193. /* Functions used:                                 */
  8194. /*       PsnsInit                                  */
  8195. /*       PsnsTerm                                  */
  8196. /*                                                 */
  8197. /* Establish a connection to PSnS and then close   */
  8198. /* it again.                                       */
  8199. /***************************************************/
  8200.  
  8201. /* Check if the REXX API DLL has been loaded.      */
  8202. Call RxFuncQuery 'PSNSLOADFUNCS'
  8203. /* If not, it is loaded.                           */
  8204. If result = 1 Then Do
  8205.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8206. /* If the DLL doesn't load correctly, the program  */
  8207. /* exits.                                          */
  8208.    If result <> 0 Then Do
  8209.       Say "Could not load the rexxapi dll"
  8210.       Exit
  8211.    End
  8212. End
  8213. /* Load up the functions within the DLL.           */
  8214. Call PSNSLOADFUNCS
  8215.  
  8216. /* Connect to PSnS.                                */
  8217. Call PsnsInit 'handle', 'PIPE'
  8218. /* Check it worked. (A result of 0 is successful)  */
  8219. If result = 0 Then Say "Successful connection"
  8220. Else Say "Unsuccessful connection"
  8221.  
  8222. /* Disconnect                                      */
  8223. Call PsnsTerm handle
  8224. /* Check it worked. (A result of 0 is successful)  */
  8225. If result = 0 Then Say "Successful disconnection"
  8226. Else Say "Unsuccessful disconnection"
  8227.  
  8228. /* Quit the program                                */
  8229. Exit
  8230.  
  8231.  
  8232. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8233.  
  8234. /* PSnS REXX example program.                      */
  8235.  
  8236. /***************************************************/
  8237. /* Functions used:                                 */
  8238. /*       PsnsDeleteRestoreMethod                   */
  8239. /*       PsnsListRestoreMethods                    */
  8240. /*                                                 */
  8241. /* Delete restore methods which don't restore all  */
  8242. /* files.                                          */
  8243. /***************************************************/
  8244.  
  8245. Call RxFuncQuery 'PSNSLOADFUNCS'
  8246. If result = 1 Then Do
  8247.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8248.    If result <> 0 Then Do
  8249.       Say "Could not load the rexxapi dll"
  8250.       Exit
  8251.    End
  8252. End
  8253. Call PSNSLOADFUNCS
  8254.  
  8255. Call PsnsInit 'handle', 'PIPE'
  8256.  
  8257. /* List all the restore methods.                   */
  8258. /* Drop the stem to be used.                       */
  8259. Call PsnsListRestoreMethods handle, 'stemmed'
  8260. Say 'PsnsListRestoreMethods returned' result
  8261.  
  8262. /* For all the restore methods with the allfiles   */
  8263. /* flag false, print their name and delete them.   */
  8264. Do x=1 to stemmed.0
  8265.    If stemmed.x.0allFiles=0 Then Do
  8266.       Say stemmed.x.0name
  8267.       Call PsnsDeleteRestoreMethod handle, stemmed.x.0name
  8268.    End
  8269. End
  8270.  
  8271. Call PsnsTerm handle
  8272. Exit
  8273.  
  8274.  
  8275. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8276.  
  8277. /* PSnS REXX example program.                      */
  8278.  
  8279. /***************************************************/
  8280. /* Functions used:                                 */
  8281. /*       PsnsCreateRestoreMethod                   */
  8282. /*       PsnsEstimateRestoreMethod                 */
  8283. /*       PsnsRestoreMethodInfo                     */
  8284. /*                                                 */
  8285. /* Create a restore method to restore all .cmd     */
  8286. /* files to their original locations, and find out */
  8287. /* how many files would be restored.               */
  8288. /***************************************************/
  8289.  
  8290. Call RxFuncQuery 'PSNSLOADFUNCS'
  8291. If result = 1 Then Do
  8292.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8293.    If result <> 0 Then Do
  8294.       Say "Could not load the rexxapi dll"
  8295.       Exit
  8296.    End
  8297. End
  8298. Call PSNSLOADFUNCS
  8299.  
  8300. Call PsnsInit 'handle', 'PIPE'
  8301.  
  8302. /* Create a new restore method.                    */
  8303. Call PsnsCreateRestoreMethod handle, 'Backup cmd Files'
  8304. Say 'PsnsCreateRestoreMethod returned' result
  8305.  
  8306. /* Set up the restore method to do what we want.   */
  8307. /* Drop the stem to be used.                       */
  8308. Drop restoreinfo.
  8309. restoreinfo.0name='Backup cmd Files'
  8310. restoreinfo.0description='Backs up all .cmd files'
  8311. restoreinfo.0allFiles=0
  8312. restoreinfo.0drive='*'
  8313. restoreinfo.0pattern='*.cmd'
  8314. restoreinfo.0subdirectories=1
  8315. restoreinfo.0byDate=0
  8316. restoreinfo.0preview=0
  8317. restoreinfo.0prompt=0
  8318. restoreinfo.0originalLocation=1
  8319. restoreinfo.0backupset='*'
  8320.  
  8321. Call PsnsRestoreMethodInfo handle, 'restoreinfo'
  8322. Say 'PsnsRestoreMethodInfo returned' result
  8323.  
  8324. /* Estimate the restore method                     */
  8325. /* Drop the stem to be used.                       */
  8326. Drop estimatestem.
  8327. Call PsnsEstimateRestoreMethod handle, 'Backup cmd Files', 'estimatestem'
  8328. /* If the estimate was successful, then the data   */
  8329. /* is returned.                                    */
  8330. If result = 0 Then Do
  8331. Say 'Files    Folders'
  8332. Say estimatestem.0files          estimatestem.0folders
  8333. End
  8334.  
  8335. Call PsnsTerm handle
  8336. Exit
  8337.  
  8338.  
  8339. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8340.  
  8341. /* PSnS REXX example program.                      */
  8342.  
  8343. /***************************************************/
  8344. /* Functions used:                                 */
  8345. /*       PsnsRenameRestoreMethod                   */
  8346. /*                                                 */
  8347. /* Rename restore method 'Guava' to 'Java'.        */
  8348. /***************************************************/
  8349.  
  8350. Call RxFuncQuery 'PSNSLOADFUNCS'
  8351. If result = 1 Then Do
  8352.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8353.    If result <> 0 Then Do
  8354.       Say "Could not load the rexxapi dll"
  8355.       Exit
  8356.    End
  8357. End
  8358. Call PSNSLOADFUNCS
  8359.  
  8360. Call PsnsInit 'handle', 'PIPE'
  8361.  
  8362. /* Rename the restore method.                      */
  8363. Call PsnsRenameRestoreMethod handle, 'Guava', 'Java'
  8364. Say 'PsnsRenameRestoreMethod returned' result
  8365.  
  8366. Call PsnsTerm handle
  8367. Exit
  8368.  
  8369.  
  8370. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8371.  
  8372. /* PSnS REXX example program.                      */
  8373.  
  8374. /***************************************************/
  8375. /* Functions used:                                 */
  8376. /*       PsnsCopyRestoreMethod                     */
  8377. /*                                                 */
  8378. /* Copy restore method 'Cat' to 'Koala'.           */
  8379. /***************************************************/
  8380.  
  8381. Call RxFuncQuery 'PSNSLOADFUNCS'
  8382. If result = 1 Then Do
  8383.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8384.    If result <> 0 Then Do
  8385.       Say "Could not load the rexxapi dll"
  8386.       Exit
  8387.    End
  8388. End
  8389. Call PSNSLOADFUNCS
  8390.  
  8391. Call PsnsInit 'handle', 'PIPE'
  8392.  
  8393. /* Copy the restore method.                        */
  8394. Call PsnsCopyRestoreMethod handle, 'Cat', 'Koala'
  8395. Say 'PsnsCopyRestoreMethod returned' result
  8396.  
  8397. Call PsnsTerm handle
  8398. Exit
  8399.  
  8400.  
  8401. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8402.  
  8403. /* PSnS REXX example program.                      */
  8404.  
  8405. /***************************************************/
  8406. /* Functions used:                                 */
  8407. /*       PsnsRunRestoreMethod                      */
  8408. /*                                                 */
  8409. /* Runs restore method 'Onion'.                    */
  8410. /***************************************************/
  8411.  
  8412. Call RxFuncQuery 'PSNSLOADFUNCS'
  8413. If result = 1 Then Do
  8414.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8415.    If result <> 0 Then Do
  8416.       Say "Could not load the rexxapi dll"
  8417.       Exit
  8418.    End
  8419. End
  8420. Call PSNSLOADFUNCS
  8421.  
  8422. Call PsnsInit 'handle', 'PIPE'
  8423.  
  8424. /* Run the restore method.                         */
  8425. Call PsnsRunRestoreMethod handle, 'Onion'
  8426. Say 'PsnsRunRestoreMethod returned' result
  8427.  
  8428. Call PsnsTerm handle
  8429. Exit
  8430.  
  8431.  
  8432. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8433.  
  8434. /* PSnS REXX example program.                      */
  8435.  
  8436. /***************************************************/
  8437. /* Functions used:                                 */
  8438. /*       PsnsDeleteBackupSet                       */
  8439. /*       PsnsListBackupSets                        */
  8440. /*                                                 */
  8441. /* Find all backup sets which use storage device   */
  8442. /* 'Drive E', and delete them.                     */
  8443. /***************************************************/
  8444.  
  8445. Call RxFuncQuery 'PSNSLOADFUNCS'
  8446. If result = 1 Then Do
  8447.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8448.    If result <> 0 Then Do
  8449.       Say "Could not load the rexxapi dll"
  8450.       Exit
  8451.    End
  8452. End
  8453. Call PSNSLOADFUNCS
  8454.  
  8455. Call PsnsInit 'handle', 'PIPE'
  8456.  
  8457. /* List all the backup sets.                       */
  8458. /* Drop the stem to be used.                       */
  8459. Drop backupsets.
  8460. Call PsnsListBackupSets handle, 'backupsets'
  8461. Say 'PsnsListBackupSets returned' result
  8462.  
  8463. /* For all the backup sets with the storage device */
  8464. /* as 'Drive E', print their name and delete them. */
  8465.  
  8466. Do x=1 to backupsets.0
  8467.    If backupsets.x.0storageDevice='Drive E' Then Do
  8468.       Say backupsets.x.0name
  8469.       Call PsnsDeleteBackupSet handle, backupsets.x.0name
  8470.    End
  8471. End
  8472.  
  8473. Call PsnsTerm handle
  8474. Exit
  8475.  
  8476.  
  8477. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8478.  
  8479. /* PSnS REXX example program.                      */
  8480.  
  8481. /***************************************************/
  8482. /* Functions used:                                 */
  8483. /*       PsnsBackupSetInfo                         */
  8484. /*       PsnsCreateBackupSet                       */
  8485. /*                                                 */
  8486. /* Create a backup set on storage device 'Drive E' */
  8487. /* and set its description.                        */
  8488. /***************************************************/
  8489.  
  8490. Call RxFuncQuery 'PSNSLOADFUNCS'
  8491. If result = 1 Then Do
  8492.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8493.    If result <> 0 Then Do
  8494.       Say "Could not load the rexxapi dll"
  8495.       Exit
  8496.    End
  8497. End
  8498. Call PSNSLOADFUNCS
  8499.  
  8500. Call PsnsInit 'handle', 'PIPE'
  8501.  
  8502. /* Create a new backup set.                        */
  8503. Call PsnsCreateBackupSet handle, 'Mule', 'Drive E', 'PATH=Dodgy'
  8504. Say 'PsnsCreateBackupSet returned' result
  8505.  
  8506. /* Set the description.                            */
  8507. /* Drop the stem to be used.                       */
  8508. Drop setinfo.
  8509. setinfo.0name='Mule'
  8510. setinfo.0description='Contains back up of Mule project'
  8511.  
  8512. Call PsnsBackupSetInfo handle, 'setinfo'
  8513. Say 'PsnsBackupSetInfo returned' result
  8514.  
  8515. Call PsnsTerm handle
  8516. Exit
  8517.  
  8518.  
  8519. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8520.  
  8521. /* PSnS REXX example program.                      */
  8522.  
  8523. /***************************************************/
  8524. /* Functions used:                                 */
  8525. /*       PsnsTransferBackupSet                     */
  8526. /*                                                 */
  8527. /* Transfer out a named backup set.                */
  8528. /***************************************************/
  8529.  
  8530. Call RxFuncQuery 'PSNSLOADFUNCS'
  8531. If result = 1 Then Do
  8532.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8533.    If result <> 0 Then Do
  8534.       Say "Could not load the rexxapi dll"
  8535.       Exit
  8536.    End
  8537. End
  8538. Call PSNSLOADFUNCS
  8539.  
  8540. Call PsnsInit 'handle', 'PIPE'
  8541.  
  8542. /* Transfer the backup set out.                    */
  8543. Call PsnsTransferBackupSet handle, 'Mule', 'OUT'
  8544. Say 'PsnsTransferBackupSet returned' result
  8545.  
  8546. Call PsnsTerm handle
  8547. Exit
  8548.  
  8549.  
  8550. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8551.  
  8552. /* PSnS REXX example program.                      */
  8553.  
  8554. /***************************************************/
  8555. /* Functions used:                                 */
  8556. /*       PsnsEmptyBackupSet                        */
  8557. /*                                                 */
  8558. /* Empty backup set 'backset'.                     */
  8559. /***************************************************/
  8560.  
  8561. Call RxFuncQuery 'PSNSLOADFUNCS'
  8562. If result = 1 Then Do
  8563.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8564.    If result <> 0 Then Do
  8565.       Say "Could not load the rexxapi dll"
  8566.       Exit
  8567.    End
  8568. End
  8569. Call PSNSLOADFUNCS
  8570.  
  8571. Call PsnsInit 'handle', 'PIPE'
  8572.  
  8573. /* Empty the backup set.                           */
  8574. Call PsnsEmptyBackupSet handle, 'backset'
  8575. Say 'PsnsEmptyBackupSet returned' result
  8576.  
  8577. Call PsnsTerm handle
  8578. Exit
  8579.  
  8580.  
  8581. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8582.  
  8583. /* PSnS REXX example program.                      */
  8584.  
  8585. /***************************************************/
  8586. /* Functions used:                                 */
  8587. /*       PsnsGetLogFile                            */
  8588. /*                                                 */
  8589. /* Gets the name of the log file for backup set    */
  8590. /* 'Drive C(General)'.                             */
  8591. /***************************************************/
  8592.  
  8593. Call RxFuncQuery 'PSNSLOADFUNCS'
  8594. If result = 1 Then Do
  8595.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8596.    If result <> 0 Then Do
  8597.       Say "Could not load the rexxapi dll"
  8598.       Exit
  8599.    End
  8600. End
  8601. Call PSNSLOADFUNCS
  8602.  
  8603. Call PsnsInit 'handle', 'PIPE'
  8604.  
  8605. /* Set the name of the backup set we want the log  */
  8606. /* file of.                                        */
  8607. /* Drop the stem to be used.                       */
  8608. Drop stemname.
  8609. stemname.0name='Drive C (General)'
  8610. Call PsnsGetLogFile handle, stemname
  8611. /* Give the log file name, if the request was      */
  8612. /* successful.                                     */
  8613. If result = 0 Then Say 'The log file name is' stemname.0logfile
  8614.  
  8615. Call PsnsTerm handle
  8616. Exit
  8617.  
  8618.  
  8619. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8620.  
  8621. /* PSnS REXX example program.                      */
  8622.  
  8623. /***************************************************/
  8624. /* Functions used:                                 */
  8625. /*       PsnsGetBackupSetConfig                    */
  8626. /*       PsnsSetBackupSetConfig                    */
  8627. /*                                                 */
  8628. /* Ensure that an optical backup set doesn't play  */
  8629. /* a sound when requesting a volume.               */
  8630. /***************************************************/
  8631.  
  8632. Call RxFuncQuery 'PSNSLOADFUNCS'
  8633. If result = 1 Then Do
  8634.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8635.    If result <> 0 Then Do
  8636.       Say "Could not load the rexxapi dll"
  8637.       Exit
  8638.    End
  8639. End
  8640. Call PSNSLOADFUNCS
  8641.  
  8642. Call PsnsInit 'handle', 'PIPE'
  8643.  
  8644. /* Get the backup set configuration.               */
  8645. /* Drop the stem to be used.                       */
  8646. Drop config.
  8647. config.0name='RW Optical G (General)'
  8648. Call PsnsGetBackupSetConfig handle, 'config'
  8649. Say 'PsnsGetBackupSetConfig returned' result
  8650. If result = 0 then Do
  8651. Say 'The configuration string is' config.0confString
  8652. End
  8653.  
  8654. /* Now set the backup set configuration.           */
  8655. Call PsnsSetBackupSetConfig handle, config.0name, 'BEEP=NO'
  8656. Say 'PsnsSetBackupSetConfig returned' result
  8657.  
  8658. Call PsnsTerm handle
  8659. Exit
  8660.  
  8661.  
  8662. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8663.  
  8664. /* PSnS REXX example program.                      */
  8665.  
  8666. /***************************************************/
  8667. /* Functions used:                                 */
  8668. /*       PsnsListVolumeBackupSets                  */
  8669. /*       PsnsTransferIn                            */
  8670. /*                                                 */
  8671. /* List the backup set on an index diskette, and   */
  8672. /* transfer that backup set in.                    */
  8673. /***************************************************/
  8674.  
  8675. Call RxFuncQuery 'PSNSLOADFUNCS'
  8676. If result = 1 Then Do
  8677.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8678.    If result <> 0 Then Do
  8679.       Say "Could not load the rexxapi dll"
  8680.       Exit
  8681.    End
  8682. End
  8683. Call PSNSLOADFUNCS
  8684.  
  8685. Call PsnsInit 'handle', 'PIPE'
  8686.  
  8687. /* List the backup set on this storage device.     */
  8688. /* Drop the stem to be used.                       */
  8689. Call PsnsListVolumeBackupSets handle, 'Tangerine', 0, 'Diskette A (3.5")'
  8690. Say 'PsnsListVolumeBackupSets returned' result
  8691.  
  8692. /* For each backup set listed, transfer it in      */
  8693. If result = 0  Then Do x=1 to Tangerine.0
  8694.    Say 'The backup set is' Tangerine.x.0backupSet
  8695.    Call PsnsTransferIn handle, 'Diskette A (3.5")', Tangerine.x.0backupSet
  8696.    Say 'PsnsTransferIn returned' result
  8697. End
  8698.  
  8699. Call PsnsTerm handle
  8700. Exit
  8701.  
  8702.  
  8703. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8704.  
  8705. /* PSnS REXX example program.                      */
  8706.  
  8707. /***************************************************/
  8708. /* Functions used:                                 */
  8709. /*       PsnsCreateStorageDevice                   */
  8710. /*       PsnsListCreatableStorageDevices           */
  8711. /*                                                 */
  8712. /* List the creatable storage devices, and create  */
  8713. /* a new storage device.                           */
  8714. /***************************************************/
  8715.  
  8716. Call RxFuncQuery 'PSNSLOADFUNCS'
  8717. If result = 1 Then Do
  8718.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8719.    If result <> 0 Then Do
  8720.       Say "Could not load the rexxapi dll"
  8721.       Exit
  8722.    End
  8723. End
  8724. Call PSNSLOADFUNCS
  8725.  
  8726. Call PsnsInit 'handle', 'PIPE'
  8727.  
  8728. /* List all the creatable storage devices.         */
  8729. /* Drop the stem to be used.                       */
  8730. Drop pear.
  8731. Call PsnsListCreatableStorageDevices handle, 'pear'
  8732. Say 'PsnsListCreatableStorageDevices returned' result
  8733.  
  8734. /* For all the creatable types of storage device,  */
  8735. /* print their name.                               */
  8736. Do x=1 to pear.0
  8737.    Say pear.x.0name
  8738.    End
  8739.  
  8740. /* Create the storage device now                   */
  8741. Call PsnsCreateStorageDevice handle, 'Hard Disk', 'DRIVE=D;PATH=S'
  8742. Say 'PsnsCreateStorageDevice returned' result
  8743.  
  8744. Call PsnsTerm handle
  8745. Exit
  8746.  
  8747.  
  8748. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8749.  
  8750. /* PSnS REXX example program.                      */
  8751.  
  8752. /***************************************************/
  8753. /* Functions used:                                 */
  8754. /*       PsnsRefreshStorageDevices                 */
  8755. /*                                                 */
  8756. /* Refresh the list of available storage devices.  */
  8757. /***************************************************/
  8758.  
  8759. Call RxFuncQuery 'PSNSLOADFUNCS'
  8760. If result = 1 Then Do
  8761.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8762.    If result <> 0 Then Do
  8763.       Say "Could not load the rexxapi dll"
  8764.       Exit
  8765.    End
  8766. End
  8767. Call PSNSLOADFUNCS
  8768.  
  8769. Call PsnsInit 'handle', 'PIPE'
  8770.  
  8771. /* Refresh the storage devices.                    */
  8772. Call PsnsRefreshStorageDevices handle
  8773. Say 'PsnsRefreshStorageDevices returned' result
  8774.  
  8775. Call PsnsTerm handle
  8776. Exit
  8777.  
  8778.  
  8779. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8780.  
  8781. /* PSnS REXX example program.                      */
  8782.  
  8783. /***************************************************/
  8784. /* Functions used:                                 */
  8785. /*       PsnsDeleteStorageDevice                   */
  8786. /*                                                 */
  8787. /* Delete storage device 'Drive E'.                */
  8788. /***************************************************/
  8789.  
  8790. Call RxFuncQuery 'PSNSLOADFUNCS'
  8791. If result = 1 Then Do
  8792.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8793.    If result <> 0 Then Do
  8794.       Say "Could not load the rexxapi dll"
  8795.       Exit
  8796.    End
  8797. End
  8798. Call PSNSLOADFUNCS
  8799.  
  8800. Call PsnsInit 'handle', 'PIPE'
  8801.  
  8802. /* Delete the storage device.                      */
  8803. Call PsnsDeleteStorageDevice handle, 'Drive E'
  8804. Say 'PsnsDeleteStorageDevice returned' result
  8805.  
  8806. Call PsnsTerm handle
  8807. Exit
  8808.  
  8809.  
  8810. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8811.  
  8812. /* PSnS REXX example program.                      */
  8813.  
  8814. /***************************************************/
  8815. /* Functions used:                                 */
  8816. /*       PsnsStorageDeviceInfo                     */
  8817. /*                                                 */
  8818. /* Find out which dynamic link library (DLL) is    */
  8819. /* used by storage device 'Drive D'                */
  8820. /***************************************************/
  8821.  
  8822. Call RxFuncQuery 'PSNSLOADFUNCS'
  8823. If result = 1 Then Do
  8824.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8825.    If result <> 0 Then Do
  8826.       Say "Could not load the rexxapi dll"
  8827.       Exit
  8828.    End
  8829. End
  8830. Call PSNSLOADFUNCS
  8831.  
  8832. Call PsnsInit 'handle', 'PIPE'
  8833.  
  8834. /* Drop the stem to be used.                       */
  8835. Drop tiny.
  8836. tiny.0name='Drive D'
  8837. Call PsnsStorageDeviceInfo handle, 'tiny'
  8838. /* If the call was successful, then the data is    */
  8839. /* returned.                                       */
  8840. If result = 0 Then Do
  8841. Say 'The DLL name is' tiny.0dllName
  8842. End
  8843.  
  8844. Call PsnsTerm handle
  8845. Exit
  8846.  
  8847.  
  8848. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8849.  
  8850. /* PSnS REXX example program.                      */
  8851.  
  8852. /***************************************************/
  8853. /* Functions used:                                 */
  8854. /*       PsnsListStorageDevices                    */
  8855. /*                                                 */
  8856. /* List the storage devices, and their DLL name.   */
  8857. /***************************************************/
  8858.  
  8859. Call RxFuncQuery 'PSNSLOADFUNCS'
  8860. If result = 1 Then Do
  8861.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8862.    If result <> 0 Then Do
  8863.       Say "Could not load the rexxapi dll"
  8864.       Exit
  8865.    End
  8866. End
  8867. Call PSNSLOADFUNCS
  8868.  
  8869. Call PsnsInit 'handle', 'PIPE'
  8870.  
  8871. /* List all the storage devices.                   */
  8872. /* Drop the stem to be used.                       */
  8873. Drop tomato.
  8874. Call PsnsListStorageDevices handle, 'tomato'
  8875. Say 'PsnsListStorageDevices returned' result
  8876.  
  8877. /* For all the storage devices, print their name   */
  8878. /* and the name of the DLL used.                   */
  8879. Do x=1 to tomato.0
  8880.    Say tomato.x.0name '*^*' tomato.x.0dllName
  8881.    End
  8882.  
  8883. Call PsnsTerm handle
  8884. Exit
  8885.  
  8886.  
  8887. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8888.  
  8889. /* PSnS REXX example program.                      */
  8890.  
  8891. /***************************************************/
  8892. /* Functions used:                                 */
  8893. /*       PsnsGetStorageDeviceConfig                */
  8894. /*                                                 */
  8895. /* Print out the configuration string for a        */
  8896. /* selected device.                                */
  8897. /***************************************************/
  8898.  
  8899. Call RxFuncQuery 'PSNSLOADFUNCS'
  8900. If result = 1 Then Do
  8901.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8902.    If result <> 0 Then Do
  8903.       Say "Could not load the rexxapi dll"
  8904.       Exit
  8905.    End
  8906. End
  8907. Call PSNSLOADFUNCS
  8908.  
  8909. Call PsnsInit 'handle', 'PIPE'
  8910.  
  8911. /* Query the configuration string, and display it. */
  8912. /* Drop the stem to be used.                       */
  8913. Drop tomato.
  8914. tomato.0storageDevice='Drive E'
  8915. Call PsnsGetStorageDeviceConfig handle, 'tomato'
  8916. Say 'PsnsGetStorageDeviceConfig returned' result
  8917. If result=0 Then Say 'The configuration string is' tomato.0confString
  8918.  
  8919. Call PsnsTerm handle
  8920. Exit
  8921.  
  8922.  
  8923. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8924.  
  8925. /* PSnS REXX example program.                      */
  8926.  
  8927. /***************************************************/
  8928. /* Functions used:                                 */
  8929. /*       PsnsSetStorageDeviceConfig                */
  8930. /*                                                 */
  8931. /* Update the location of the ADSM options file.   */
  8932. /***************************************************/
  8933.  
  8934. Call RxFuncQuery 'PSNSLOADFUNCS'
  8935. If result = 1 Then Do
  8936.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8937.    If result <> 0 Then Do
  8938.       Say "Could not load the rexxapi dll"
  8939.       Exit
  8940.    End
  8941. End
  8942. Call PSNSLOADFUNCS
  8943.  
  8944. Call PsnsInit 'handle', 'PIPE'
  8945.  
  8946. /* Update the configuration string, and display    */
  8947. /* it.                                             */
  8948. Call PsnsSetStorageDeviceConfig handle, 'ADSM', 'MAXOBJECTS=23;'
  8949. Say 'PsnsSetStorageDeviceConfig returned' result
  8950.  
  8951. Call PsnsTerm handle
  8952. Exit
  8953.  
  8954.  
  8955. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  8956.  
  8957. /* PSnS REXX example program.                      */
  8958.  
  8959. /***************************************************/
  8960. /* Functions used:                                 */
  8961. /*       PsnsListVolumeBackupSets                  */
  8962. /*       PsnsVolumeInfo                            */
  8963. /*                                                 */
  8964. /* Print out space usage information for a volume, */
  8965. /* and see which backup sets are associated with   */
  8966. /* it.                                             */
  8967. /***************************************************/
  8968.  
  8969. Call RxFuncQuery 'PSNSLOADFUNCS'
  8970. If result = 1 Then Do
  8971.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  8972.    If result <> 0 Then Do
  8973.       Say "Could not load the rexxapi dll"
  8974.       Exit
  8975.    End
  8976. End
  8977. Call PSNSLOADFUNCS
  8978.  
  8979. Call PsnsInit 'handle', 'PIPE'
  8980.  
  8981. /* List the space usage for volume '1'   */
  8982. /* Drop the stem to be used.             */
  8983. Drop volume.
  8984. Call PsnsVolumeInfo handle, 'volume', '1'
  8985. Say 'PsnsVolumeInfo returned' result
  8986.  
  8987. /* If the call was successful, then the data is */
  8988. /* returned.                                    */
  8989. If result = 0 Then Do
  8990. Say 'Total Capacity    PSnS Used'
  8991. Say '   ' volume.0totalCapacity '        ' volume.0psnsUsed
  8992. End
  8993.  
  8994. /* Now print out the backup sets associated     */
  8995. /* with this volume.                            */
  8996. /* Drop the stem to be used.                    */
  8997. Drop info.
  8998. Call PsnsListVolumeBackupSets handle, 'info', '1'
  8999. /* If the call was successful, then the data is */
  9000. /* returned.                                    */
  9001. If result = 0 then
  9002.    Do x=1 to info.0
  9003.       Say 'Backup set' info.x.0backupSet ':' info.x.0spaceUsed
  9004.    End
  9005.  
  9006. Call PsnsTerm handle
  9007. Exit
  9008.  
  9009.  
  9010. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9011.  
  9012. /* PSnS REXX example program.                      */
  9013.  
  9014. /***************************************************/
  9015. /* Functions used:                                 */
  9016. /*       PsnsDeleteVolume                          */
  9017. /*       PsnsListVolumes                           */
  9018. /*                                                 */
  9019. /* Find all volumes on a storage device which have */
  9020. /* no space used on them, and delete them.         */
  9021. /***************************************************/
  9022.  
  9023. Call RxFuncQuery 'PSNSLOADFUNCS'
  9024. If result = 1 Then Do
  9025.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9026.    If result <> 0 Then Do
  9027.       Say "Could not load the rexxapi dll"
  9028.       Exit
  9029.    End
  9030. End
  9031. Call PSNSLOADFUNCS
  9032.  
  9033. Call PsnsInit 'handle', 'PIPE'
  9034.  
  9035. /* List all the volumes.                           */
  9036. /* Drop the stem to be used.                       */
  9037. Drop list.
  9038. Call PsnsListVolumes handle, 'list'
  9039. Say 'PsnsListVolumes returned' result
  9040.  
  9041. /* Check for those with no space used on them, and */
  9042. /* delete them.                                    */
  9043. Do x=1 to list.0
  9044.    If list.x.0psnsUsed < 2 then Do
  9045.       Say 'Deleting Backup set' list.x.0name 'with' list.x.0psnsUsed 'used'
  9046.       Call PsnsDeleteVolume handle, list.x.0id
  9047.    End
  9048. End
  9049.  
  9050. Call PsnsTerm handle
  9051. Exit
  9052.  
  9053.  
  9054. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9055.  
  9056. /* PSnS REXX example program.                      */
  9057.  
  9058. /***************************************************/
  9059. /* Functions used:                                 */
  9060. /*       PsnsActivateVolume                        */
  9061. /*       PsnsAssociateVolume                       */
  9062. /*       PsnsCreateVolume                          */
  9063. /*                                                 */
  9064. /* Create a new diskette volume, associate it with */
  9065. /* backup set 'bucket' and mark it as inactive.    */
  9066. /***************************************************/
  9067.  
  9068. Call RxFuncQuery 'PSNSLOADFUNCS'
  9069. If result = 1 Then Do
  9070.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9071.    If result <> 0 Then Do
  9072.       Say "Could not load the rexxapi dll"
  9073.       Exit
  9074.    End
  9075. End
  9076. Call PSNSLOADFUNCS
  9077.  
  9078. Call PsnsInit 'handle', 'PIPE'
  9079.  
  9080. /* Create a new volume.                            */
  9081. Call PsnsCreateVolume handle, '3.5" Diskette'
  9082. Say 'PsnsCreateVolume returned' result
  9083. Say 'The ID for it is' volumeID
  9084.  
  9085. /* Associate this volume with 'bucket' backup set  */
  9086. Call PsnsAssociateVolume handle, volumeID, "bucket"
  9087. Say 'PsnsAssociateVolume returned' result
  9088.  
  9089. /* Deactivate this volume                          */
  9090. Call PsnsActivateVolume handle, volumeID, "DEACTIVATE"
  9091. Say 'PsnsActivateVolume returned' result
  9092.  
  9093. Call PsnsTerm handle
  9094. Exit
  9095.  
  9096.  
  9097. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9098.  
  9099. /* PSnS REXX example program.                      */
  9100.  
  9101. /***************************************************/
  9102. /* Functions used:                                 */
  9103. /*       PsnsCreateEvent                           */
  9104. /*       PsnsEventInfo                             */
  9105. /*                                                 */
  9106. /* Create a new event to perform an hourly backup  */
  9107. /* with backup method 'Orange'.                    */
  9108. /***************************************************/
  9109.  
  9110. Call RxFuncQuery 'PSNSLOADFUNCS'
  9111. If result = 1 Then Do
  9112.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9113.    If result <> 0 Then Do
  9114.       Say "Could not load the rexxapi dll"
  9115.       Exit
  9116.    End
  9117. End
  9118. Call PSNSLOADFUNCS
  9119.  
  9120. Call PsnsInit 'handle', 'PIPE'
  9121.  
  9122. /* Create the new event.                           */
  9123. Call PsnsCreateEvent handle, 'REGULAR', 'Orange'
  9124. Say 'PsnsCreateEvent returned' result
  9125. Say 'The ID of this event is' eventID
  9126.  
  9127. /* Set up the time of the event.                   */
  9128. /* Drop the stem to be used.                       */
  9129. Drop info.
  9130. info.0hours='1'
  9131. info.0minutes='0'
  9132. info.0changedFilesOnly='AS_METHOD'
  9133. info.0showPreview='NO'
  9134. info.0active='TRUE'
  9135. info.0backupMethod='Orange'
  9136. Call PsnsEventInfo handle, 'info', eventID
  9137. Say 'PsnsEventInfo returned' result
  9138.  
  9139. Call PsnsTerm handle
  9140. Exit
  9141.  
  9142.  
  9143. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9144.  
  9145. /* PSnS REXX example program.                      */
  9146.  
  9147. /***************************************************/
  9148. /* Functions used:                                 */
  9149. /*       PsnsActivateEvent                         */
  9150. /*       PsnsListEvents                            */
  9151. /*                                                 */
  9152. /* List all events which use backup method 'Grape' */
  9153. /* and deactivate them.                            */
  9154. /***************************************************/
  9155.  
  9156. Call RxFuncQuery 'PSNSLOADFUNCS'
  9157. If result = 1 Then Do
  9158.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9159.    If result <> 0 Then Do
  9160.       Say "Could not load the rexxapi dll"
  9161.       Exit
  9162.    End
  9163. End
  9164. Call PSNSLOADFUNCS
  9165.  
  9166. Call PsnsInit 'handle', 'PIPE'
  9167.  
  9168. /* List all the events.                            */
  9169. /* Drop the stem to be used.                       */
  9170. Drop event.
  9171. Call PsnsListEvents handle, 'event'
  9172. Say 'PsnsListEvents returned' result
  9173.  
  9174. /* For all the events with 'Grape' as the name of  */
  9175. /* the backup method, say their ID, and            */
  9176. /* deactivate them.                                */
  9177. Do x=1 to event.0
  9178.    If event.x.0backupMethod='Grape' Then Do
  9179.       Say 'Deactivating event number' event.x.0id
  9180.       Call PsnsActivateEvent handle, event.x.0id, 'DEACTIVATE'
  9181.    End
  9182. End
  9183.  
  9184. Call PsnsTerm handle
  9185. Exit
  9186.  
  9187.  
  9188. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9189.  
  9190. /* PSnS REXX example program.                      */
  9191.  
  9192. /***************************************************/
  9193. /* Functions used:                                 */
  9194. /*       PsnsDeleteEvent                           */
  9195. /*       PsnsGetNextEvent                          */
  9196. /*                                                 */
  9197. /* Find out which is the next event to occur, and  */
  9198. /* delete it.                                      */
  9199. /***************************************************/
  9200.  
  9201. Call RxFuncQuery 'PSNSLOADFUNCS'
  9202. If result = 1 Then Do
  9203.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9204.    If result <> 0 Then Do
  9205.       Say "Could not load the rexxapi dll"
  9206.       Exit
  9207.    End
  9208. End
  9209. Call PSNSLOADFUNCS
  9210.  
  9211. Call PsnsInit 'handle', 'PIPE'
  9212.  
  9213. /* Get the next event to occur.                    */
  9214. Drop event.
  9215. Call PsnsGetNextEvent handle
  9216. Say 'PsnsGetNextEvent returned' result
  9217. If result = 36 Then Say 'No more events'
  9218. Else
  9219.    If result = 0 Then Do
  9220.       Say 'The ID of this event is' nextEventID
  9221. /* Delete the event.                               */
  9222.       Call PsnsDeleteEvent handle, nextEventID
  9223.       Say 'PsnsDeleteEvent returned' result
  9224.    End
  9225.  
  9226. Call PsnsTerm handle
  9227. Exit
  9228.  
  9229.  
  9230. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9231.  
  9232. /* PSnS REXX example program.                      */
  9233.  
  9234. /***************************************************/
  9235. /* Functions used:                                 */
  9236. /*       PsnsCopyEvent                             */
  9237. /*                                                 */
  9238. /* Copy event with the given ID and return the ID  */
  9239. /* of the new event.                               */
  9240. /***************************************************/
  9241.  
  9242. Call RxFuncQuery 'PSNSLOADFUNCS'
  9243. If result = 1 Then Do
  9244.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9245.    If result <> 0 Then Do
  9246.       Say "Could not load the rexxapi dll"
  9247.       Exit
  9248.    End
  9249. End
  9250. Call PSNSLOADFUNCS
  9251.  
  9252. Call PsnsInit 'handle', 'PIPE'
  9253.  
  9254. /* Copy the event.                                 */
  9255. Call PsnsCopyEvent handle, '1'
  9256. Say 'PsnsCopyEvent returned' result
  9257. If result = 0 Then Say 'The new event ID is' newEventID
  9258.  
  9259. Call PsnsTerm handle
  9260. Exit
  9261.  
  9262.  
  9263. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9264.  
  9265. /* PSnS REXX example program.                      */
  9266.  
  9267. /***************************************************/
  9268. /* Functions used:                                 */
  9269. /*       PsnsAddFileFilterRule                     */
  9270. /*       PsnsCreateFileFilter                      */
  9271. /*       PsnsFileFilterInfo                        */
  9272. /*                                                 */
  9273. /* Create a file filter to back up all the source  */
  9274. /* files in project 'Solutions'.                   */
  9275. /***************************************************/
  9276.  
  9277. Call RxFuncQuery 'PSNSLOADFUNCS'
  9278. If result = 1 Then Do
  9279.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9280.    If result <> 0 Then Do
  9281.       Say "Could not load the rexxapi dll"
  9282.       Exit
  9283.    End
  9284. End
  9285. Call PSNSLOADFUNCS
  9286.  
  9287. Call PsnsInit 'handle', 'PIPE'
  9288.  
  9289. /* Create a new file filter.                       */
  9290. Call PsnsCreateFileFilter handle, 'Solutions data', 'LIST'
  9291. Say 'PsnsCreateFileFilter returned' result
  9292.  
  9293. /* Set the description.                            */
  9294. /* Drop the stem to be used.                       */
  9295. drop filter.
  9296. filter.0description='Filter to select the data for the Solutions Project'
  9297. filter.0name='Solutions data'
  9298. Call PsnsFileFilterInfo handle, 'filter'
  9299. Say 'PsnsFileFilterInfo returned' result
  9300.  
  9301. /* Set up the first rule, and add it.              */
  9302. /* Drop the stem to be used.                       */
  9303. drop rule.
  9304. rule.0drive='D'
  9305. rule.0directory='\s\rexxipf'
  9306. rule.0pattern='*.ipf'
  9307. rule.0subdirectories='1'
  9308. rule.0include='1'
  9309. Call PsnsAddFileFilterRule handle, 'rule', 'Solutions data', '1'
  9310. Say 'PsnsAddFileFilterRule returned' result
  9311.  
  9312. /* Add more rules                                  */
  9313. rule.0pattern='*.cmd'
  9314. Call PsnsAddFileFilterRule handle, 'rule', 'Solutions data', '1'
  9315. Say 'PsnsAddFileFilterRule returned' result
  9316.  
  9317. Call PsnsTerm handle
  9318. Exit
  9319.  
  9320.  
  9321. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9322.  
  9323. /* PSnS REXX example program.                      */
  9324.  
  9325. /***************************************************/
  9326. /* Functions used:                                 */
  9327. /*       PsnsDeleteFileFilter                      */
  9328. /*       PsnsListFileFilters                       */
  9329. /*                                                 */
  9330. /* Delete all the file filters.                    */
  9331. /***************************************************/
  9332.  
  9333. Call RxFuncQuery 'PSNSLOADFUNCS'
  9334. If result = 1 Then Do
  9335.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9336.    If result <> 0 Then Do
  9337.       Say "Could not load the rexxapi dll"
  9338.       Exit
  9339.    End
  9340. End
  9341. Call PSNSLOADFUNCS
  9342.  
  9343. Call PsnsInit 'handle', 'PIPE'
  9344.  
  9345. /* List all the file filters.                      */
  9346. /* Drop the stem to be used.                       */
  9347. Drop stem.
  9348. Call PsnsListFileFilters handle, 'stem'
  9349. Say 'PsnsListFileFilters returned' result
  9350.  
  9351. /* For all the file filters, print their name and  */
  9352. /* delete them.                                    */
  9353. Do x=1 to stem.0
  9354.    Say stem.x.0name 'is being deleted'
  9355.    Call PsnsDeleteFileFilter handle, stem.x.0name
  9356. End
  9357.  
  9358. Call PsnsTerm handle
  9359. Exit
  9360.  
  9361.  
  9362. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9363.  
  9364. /* PSnS REXX example program.                      */
  9365.  
  9366. /***************************************************/
  9367. /* Functions used:                                 */
  9368. /*       PsnsRenameFileFilter                      */
  9369. /*                                                 */
  9370. /* Rename file filter 'Source files' to 'Archive'. */
  9371. /***************************************************/
  9372.  
  9373. Call RxFuncQuery 'PSNSLOADFUNCS'
  9374. If result = 1 Then Do
  9375.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9376.    If result <> 0 Then Do
  9377.       Say "Could not load the rexxapi dll"
  9378.       Exit
  9379.    End
  9380. End
  9381. Call PSNSLOADFUNCS
  9382.  
  9383. Call PsnsInit 'handle', 'PIPE'
  9384.  
  9385. /* Rename the file filter.                         */
  9386. Call PsnsRenameFileFilter handle, 'Source Files', 'Archive'
  9387. Say 'PsnsRenameFileFilter returned' result
  9388.  
  9389. Call PsnsTerm handle
  9390. Exit
  9391.  
  9392.  
  9393. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9394.  
  9395. /* PSnS REXX example program.                      */
  9396.  
  9397. /***************************************************/
  9398. /* Functions used:                                 */
  9399. /*       PsnsCopyFileFilter                        */
  9400. /*                                                 */
  9401. /* Copy file filter 'Source files' to 'Archive'.   */
  9402. /***************************************************/
  9403.  
  9404. Call RxFuncQuery 'PSNSLOADFUNCS'
  9405. If result = 1 Then Do
  9406.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9407.    If result <> 0 Then Do
  9408.       Say "Could not load the rexxapi dll"
  9409.       Exit
  9410.    End
  9411. End
  9412. Call PSNSLOADFUNCS
  9413.  
  9414. Call PsnsInit 'handle', 'PIPE'
  9415.  
  9416. /* Copy the file filter.                           */
  9417. Call PsnsCopyFileFilter handle, 'Source Files', 'Archive'
  9418. Say 'PsnsCopyFileFilter returned' result
  9419.  
  9420. Call PsnsTerm handle
  9421. Exit
  9422.  
  9423.  
  9424. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9425.  
  9426. /* PSnS REXX example program.                      */
  9427.  
  9428. /***************************************************/
  9429. /* Functions used:                                 */
  9430. /*       PsnsFileFilterInfo                        */
  9431. /*       PsnsFileFilterRuleInfo                    */
  9432. /*                                                 */
  9433. /* Print out details of a file filter.             */
  9434. /***************************************************/
  9435.  
  9436. Call RxFuncQuery 'PSNSLOADFUNCS'
  9437. If result = 1 Then Do
  9438.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9439.    If result <> 0 Then Do
  9440.       Say "Could not load the rexxapi dll"
  9441.       Exit
  9442.    End
  9443. End
  9444. Call PSNSLOADFUNCS
  9445.  
  9446. Call PsnsInit 'handle', 'PIPE'
  9447.  
  9448. /* Look at the file filter.                        */
  9449. /* Drop the stem to be used.                       */
  9450. Drop Info.
  9451. Info.0name='Data'
  9452. Call PsnsFileFilterInfo handle, 'Info'
  9453. Say 'PsnsFileFilterInfo returned' result
  9454.  
  9455. /* Look at the rules of that file filter.          */
  9456. /* Drop the stem to be used.                       */
  9457. Do x=1 to Info.0numRules
  9458.    Drop rule.
  9459.    Call PsnsFileFilterRuleInfo handle, 'rule', x, Info.0name
  9460.    Say rule.0drive':'rule.0directory 'using a pattern of' rule.0pattern
  9461. End
  9462.  
  9463. Call PsnsTerm handle
  9464. Exit
  9465.  
  9466.  
  9467. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9468.  
  9469. /* PSnS REXX example program.                      */
  9470.  
  9471. /***************************************************/
  9472. /* Functions used:                                 */
  9473. /*       PsnsDeleteFileFilterRule                  */
  9474. /*       PsnsListFileFilterRule                    */
  9475. /*                                                 */
  9476. /* Look at the first rule of a file filter, and    */
  9477. /* delete it.                                      */
  9478. /***************************************************/
  9479.  
  9480. Call RxFuncQuery 'PSNSLOADFUNCS'
  9481. If result = 1 Then Do
  9482.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9483.    If result <> 0 Then Do
  9484.       Say "Could not load the rexxapi dll"
  9485.       Exit
  9486.    End
  9487. End
  9488. Call PSNSLOADFUNCS
  9489.  
  9490. Call PsnsInit 'handle', 'PIPE'
  9491.  
  9492. /* Look at the rule.                               */
  9493. /* Drop the stem to be used.                       */
  9494. Drop rule.
  9495. Call PsnsListFileFilterRule handle, 'rule', 1, 'Current'
  9496. If result = 0 Then Do
  9497.    Say rule.0drive':'rule.0directory 'using a pattern of' rule.0pattern
  9498. End
  9499.  
  9500. /* Delete the rule.                                */
  9501. Call PsnsDeleteFileFilterRule handle, 'Current', '1'
  9502. Say 'PsnsDeleteFileFilterRule returned' result
  9503.  
  9504. Call PsnsTerm handle
  9505. Exit
  9506.  
  9507.  
  9508. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9509.  
  9510. /* PSnS REXX example program.                      */
  9511.  
  9512. /***************************************************/
  9513. /* Functions used:                                 */
  9514. /*       PsnsAddRulebookRule                       */
  9515. /*       PsnsCreateRulebook                        */
  9516. /*       PsnsRulebookInfo                          */
  9517. /*                                                 */
  9518. /* Create a rulebook to keep 10 generations of all */
  9519. /* .ecu and .cmx files.                            */
  9520. /***************************************************/
  9521.  
  9522. Call RxFuncQuery 'PSNSLOADFUNCS'
  9523. If result = 1 Then Do
  9524.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9525.    If result <> 0 Then Do
  9526.       Say "Could not load the rexxapi dll"
  9527.       Exit
  9528.    End
  9529. End
  9530. Call PSNSLOADFUNCS
  9531.  
  9532. Call PsnsInit 'handle', 'PIPE'
  9533.  
  9534. /* Create a new rulebook.                          */
  9535. Call PsnsCreateRulebook handle, 'Project Rulebook'
  9536. Say 'PsnsCreateRulebook returned' result
  9537.  
  9538. /* Set the description.                            */
  9539. /* Drop the stem to be used.                       */
  9540. drop rulebook.
  9541. rulebook.0description='Rulebook to keep 10 generations of all .ecu and .cmx files.'
  9542. rulebook.0name='Project Rulebook'
  9543. Call PsnsRulebookInfo handle, 'rulebook'
  9544. Say 'PsnsRulebookInfo returned' result
  9545.  
  9546. /* Set up the first rule, and add it.              */
  9547. /* Drop the stem to be used.                       */
  9548. drop rule.
  9549. rule.0drive='D'
  9550. rule.0directory='\'
  9551. rule.0pattern='*.ecu'
  9552. rule.0subdirectories='1'
  9553. rule.0generations='10'
  9554. rule.0compression='DEFAULT'
  9555. Call PsnsAddRulebookRule handle, 'rule', 'Project Rulebook', '1'
  9556. Say 'PsnsAddRulebookRule returned' result
  9557.  
  9558. /* Add more rules                                  */
  9559. rule.0pattern='*.cmx'
  9560. Call PsnsAddRulebookRule handle, 'rule', 'Project Rulebook', '1'
  9561. Say 'PsnsAddRulebookRule returned' result
  9562.  
  9563. Call PsnsTerm handle
  9564. Exit
  9565.  
  9566.  
  9567. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9568.  
  9569. /* PSnS REXX example program.                      */
  9570.  
  9571. /***************************************************/
  9572. /* Functions used:                                 */
  9573. /*       PsnsDeleteRulebook                        */
  9574. /*       PsnsListRulebooks                         */
  9575. /*                                                 */
  9576. /* Delete all the rulebooks.                       */
  9577. /***************************************************/
  9578.  
  9579. Call RxFuncQuery 'PSNSLOADFUNCS'
  9580. If result = 1 Then Do
  9581.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9582.    If result <> 0 Then Do
  9583.       Say "Could not load the rexxapi dll"
  9584.       Exit
  9585.    End
  9586. End
  9587. Call PSNSLOADFUNCS
  9588.  
  9589. Call PsnsInit 'handle', 'PIPE'
  9590.  
  9591. /* List all the rulebooks.                         */
  9592. /* Drop the stem to be used.                       */
  9593. Drop rulebook.
  9594. Call PsnsListRulebooks handle, 'rulebook'
  9595. Say 'PsnsListRulebooks returned' result
  9596.  
  9597. /* For all the rulebooks, print their name and     */
  9598. /* delete them.                                    */
  9599. Do x=1 to rulebook.0
  9600.    Say rulebook.x.0name 'is being deleted'
  9601.    Call PsnsDeleteRulebook handle, rulebook.x.0name
  9602. End
  9603.  
  9604. Call PsnsTerm handle
  9605. Exit
  9606.  
  9607.  
  9608. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9609.  
  9610. /* PSnS REXX example program.                      */
  9611.  
  9612. /***************************************************/
  9613. /* Functions used:                                 */
  9614. /*       PsnsRenameRulebook                        */
  9615. /*                                                 */
  9616. /* Rename rulebook 'Kumquat' to 'Kiwi'.            */
  9617. /***************************************************/
  9618.  
  9619. Call RxFuncQuery 'PSNSLOADFUNCS'
  9620. If result = 1 Then Do
  9621.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9622.    If result <> 0 Then Do
  9623.       Say "Could not load the rexxapi dll"
  9624.       Exit
  9625.    End
  9626. End
  9627. Call PSNSLOADFUNCS
  9628.  
  9629. Call PsnsInit 'handle', 'PIPE'
  9630.  
  9631. /* Rename the rulebook.                            */
  9632. Call PsnsRenameRulebook handle, 'Kumquat', 'Kiwi'
  9633. Say 'PsnsRenameRulebook returned' result
  9634.  
  9635. Call PsnsTerm handle
  9636. Exit
  9637.  
  9638.  
  9639. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9640.  
  9641. /* PSnS REXX example program.                      */
  9642.  
  9643. /***************************************************/
  9644. /* Functions used:                                 */
  9645. /*       PsnsCopyRulebook                          */
  9646. /*                                                 */
  9647. /* Copy rulebook 'Kiwi' to 'Pear'.                 */
  9648. /***************************************************/
  9649.  
  9650. Call RxFuncQuery 'PSNSLOADFUNCS'
  9651. If result = 1 Then Do
  9652.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9653.    If result <> 0 Then Do
  9654.       Say "Could not load the rexxapi dll"
  9655.       Exit
  9656.    End
  9657. End
  9658. Call PSNSLOADFUNCS
  9659.  
  9660. Call PsnsInit 'handle', 'PIPE'
  9661.  
  9662. /* Copy the rulebook.                              */
  9663. Call PsnsCopyRulebook handle, 'Kiwi', 'Pear'
  9664. Say 'PsnsCopyRulebook returned' result
  9665.  
  9666. Call PsnsTerm handle
  9667. Exit
  9668.  
  9669.  
  9670. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9671.  
  9672. /* PSnS REXX example program.                      */
  9673.  
  9674. /***************************************************/
  9675. /* Functions used:                                 */
  9676. /*       PsnsRulebookInfo                          */
  9677. /*       PsnsRulebookRuleInfo                      */
  9678. /*                                                 */
  9679. /* Print out details of a rulebook.                */
  9680. /***************************************************/
  9681.  
  9682. Call RxFuncQuery 'PSNSLOADFUNCS'
  9683. If result = 1 Then Do
  9684.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9685.    If result <> 0 Then Do
  9686.       Say "Could not load the rexxapi dll"
  9687.       Exit
  9688.    End
  9689. End
  9690. Call PSNSLOADFUNCS
  9691.  
  9692. Call PsnsInit 'handle', 'PIPE'
  9693.  
  9694. /* Look at the rulebook.                           */
  9695. /* Drop the stem to be used.                       */
  9696. Drop Data.
  9697. Data.0name='Current'
  9698. Call PsnsRulebookInfo handle, 'Data'
  9699. Say 'PsnsRulebookInfo returned' result
  9700.  
  9701. /* Look at the rules of that rulebook.             */
  9702. /* Drop the stem to be used.                       */
  9703. Do x=1 to Data.0numRules
  9704.    Drop rule.
  9705.    Call PsnsRulebookRuleInfo handle, 'rule', x, 'Current'
  9706.    Say rule.0drive':'rule.0directory 'using a pattern of' rule.0pattern
  9707.    Say rule.0generations 'generations of files are to be backed up'
  9708. End
  9709.  
  9710. Call PsnsTerm handle
  9711. Exit
  9712.  
  9713.  
  9714. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9715.  
  9716. /* PSnS REXX example program.                      */
  9717.  
  9718. /***************************************************/
  9719. /* Functions used:                                 */
  9720. /*       PsnsDeleteRulebookRule                    */
  9721. /*       PsnsListRulebookRule                      */
  9722. /*                                                 */
  9723. /* Look at the first rule of a rulebook, and       */
  9724. /* delete it.                                      */
  9725. /***************************************************/
  9726.  
  9727. Call RxFuncQuery 'PSNSLOADFUNCS'
  9728. If result = 1 Then Do
  9729.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9730.    If result <> 0 Then Do
  9731.       Say "Could not load the rexxapi dll"
  9732.       Exit
  9733.    End
  9734. End
  9735. Call PSNSLOADFUNCS
  9736.  
  9737. Call PsnsInit 'handle', 'PIPE'
  9738.  
  9739. /* Look at the rule.                               */
  9740. /* Drop the stem to be used.                       */
  9741. Drop rule.
  9742. Call PsnsListRulebookRule handle, 'rule', 1, 'Current'
  9743. If result = 0 Then Do
  9744.    Say rule.0drive':'rule.0directory 'using a pattern of' rule.0pattern
  9745. End
  9746.  
  9747. /* Delete the rule.                                */
  9748. Call PsnsDeleteRulebookRule handle, 'Current', '1'
  9749. Say 'PsnsDeleteRulebookRule returned' result
  9750.  
  9751. Call PsnsTerm handle
  9752. Exit
  9753.  
  9754.  
  9755. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9756.  
  9757. /* PSnS REXX example program.                      */
  9758.  
  9759. /***************************************************/
  9760. /* Functions used:                                 */
  9761. /*       PsnsListSourceDrives                      */
  9762. /*       PsnsSelectSourceDrive                     */
  9763. /*                                                 */
  9764. /* Deselect all LAN drives for backup.             */
  9765. /***************************************************/
  9766.  
  9767. Call RxFuncQuery 'PSNSLOADFUNCS'
  9768. If result = 1 Then Do
  9769.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9770.    If result <> 0 Then Do
  9771.       Say "Could not load the rexxapi dll"
  9772.       Exit
  9773.    End
  9774. End
  9775. Call PSNSLOADFUNCS
  9776.  
  9777. Call PsnsInit 'handle', 'PIPE'
  9778.  
  9779. /* List all the source drives.                     */
  9780. /* Drop the stem to be used.                       */
  9781. Drop drives.
  9782. Call PsnsListSourceDrives handle, 'drives'
  9783. Say 'PsnsListSourceDrives returned' result
  9784.  
  9785. /* For all the source drives which are LAN drives, */
  9786. /* print their name and deselect them.             */
  9787. Do x=1 to drives.0
  9788.    If drives.x.0type='LANDRIVE' & drives.x.0selected='1' Then Do
  9789.       Say 'Drive' drives.x.0driveLetter 'is being deselected'
  9790.       Call PsnsSelectSourceDrive handle, drives.x.0driveLetter, 'DESELECT'
  9791.    End
  9792. End
  9793.  
  9794. Call PsnsTerm handle
  9795. Exit
  9796.  
  9797.  
  9798. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9799.  
  9800. /* PSnS REXX example program.                      */
  9801.  
  9802. /***************************************************/
  9803. /* Functions used:                                 */
  9804. /*       PsnsRefreshSourceDrives                   */
  9805. /*       PsnsSourceDriveType                       */
  9806. /*                                                 */
  9807. /* Refresh the list of source drives, and set the  */
  9808. /* type of Drive Z to be a hard disk.              */
  9809. /***************************************************/
  9810.  
  9811. Call RxFuncQuery 'PSNSLOADFUNCS'
  9812. If result = 1 Then Do
  9813.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9814.    If result <> 0 Then Do
  9815.       Say "Could not load the rexxapi dll"
  9816.       Exit
  9817.    End
  9818. End
  9819. Call PSNSLOADFUNCS
  9820.  
  9821. Call PsnsInit 'handle', 'PIPE'
  9822.  
  9823. /* Refresh the source drives.                      */
  9824. Call PsnsRefreshSourceDrives handle
  9825. Say 'PsnsRefreshSourceDrives returned' result
  9826.  
  9827. /* Change the type of Drive Z.                     */
  9828. Call PsnsSourceDriveType handle, 'Z', 'HARDDISK'
  9829. Say 'PsnsSourceDriveType returned' result
  9830.  
  9831. Call PsnsTerm handle
  9832. Exit
  9833.  
  9834.  
  9835. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9836.  
  9837. /* PSnS REXX example program.                      */
  9838.  
  9839. /***************************************************/
  9840. /* Functions used:                                 */
  9841. /*       PsnsAddFile                               */
  9842. /*       PsnsDropFiles                             */
  9843. /*       PsnsListFiles                             */
  9844. /*       PsnsPurgeFiles                            */
  9845. /*                                                 */
  9846. /* Find all files bigger than a certain size, and  */
  9847. /* drop them.                                      */
  9848. /***************************************************/
  9849.  
  9850. Call RxFuncQuery 'PSNSLOADFUNCS'
  9851. If result = 1 Then Do
  9852.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9853.    If result <> 0 Then Do
  9854.       Say "Could not load the rexxapi dll"
  9855.       Exit
  9856.    End
  9857. End
  9858. Call PSNSLOADFUNCS
  9859.  
  9860. Call PsnsInit 'handle', 'PIPE'
  9861.  
  9862. /* List all the files.                             */
  9863. /* Drop the stem to be used.                       */
  9864. Drop stem.
  9865. stem.0backupSet='Recovery'
  9866. Call PsnsListFiles handle, 'stem'
  9867. Say 'PsnsListFiles returned' result
  9868.  
  9869. /* For all the files bigger than 1000000, print    */
  9870. /* their name and add them to the list of files.   */
  9871. Do x=1 to stem.0
  9872.    If stem.x.0size>1000000 Then Do
  9873.       Say stem.x.0filename 'is being dropped from' stem.x.0backupSet
  9874.       Say 'and is of size' stem.x.0size
  9875.       Say
  9876.       Call PsnsAddFile handle, stem.x.0filename
  9877. /* If there is problem, stop the operation.        */
  9878.       If result<>0 Then Do
  9879.          Say 'Error encountered'
  9880.          PsnsPurgeFiles handle
  9881.       End
  9882.    End
  9883. End
  9884.  
  9885. /* Drop the files                                  */
  9886. Say 'About to drop files'
  9887. Call PsnsDropFiles handle, 'Recovery'
  9888. Say 'PsnsDropFiles returned' result
  9889.  
  9890. Call PsnsTerm handle
  9891. Exit
  9892.  
  9893.  
  9894. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9895.  
  9896. /* PSnS REXX example program.                      */
  9897.  
  9898. /***************************************************/
  9899. /* Functions used:                                 */
  9900. /*       PsnsAddFile                               */
  9901. /*       PsnsBackupFiles                           */
  9902. /*       PsnsPurgeFiles                            */
  9903. /*                                                 */
  9904. /* Back up a selection of files.                   */
  9905. /***************************************************/
  9906.  
  9907. Call RxFuncQuery 'PSNSLOADFUNCS'
  9908. If result = 1 Then Do
  9909.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9910.    If result <> 0 Then Do
  9911.       Say "Could not load the rexxapi dll"
  9912.       Exit
  9913.    End
  9914. End
  9915. Call PSNSLOADFUNCS
  9916.  
  9917. Call PsnsInit 'handle', 'PIPE'
  9918.  
  9919. /* Empty the file list for this handle.            */
  9920. Call PsnsPurgeFiles handle
  9921. Say 'PsnsPurgeFiles returned' result
  9922.  
  9923. /* Add a file to the list.                         */
  9924. Call PsnsAddFile handle, 'D:\s\m.cmd'
  9925. Say 'PsnsAddFile returned' result
  9926.  
  9927. /* Add a directory and its contents                */
  9928. Call PsnsAddFile handle, 'D:\s\backup\'
  9929. Say 'PsnsAddFile returned' result
  9930.  
  9931. /* Add a directory and all files & directories     */
  9932. /* below it.                                       */
  9933. Call PsnsAddFile handle, 'D:\s\psnstemp\*\'
  9934. Say 'PsnsAddFile returned' result
  9935.  
  9936. /* Fill in some details for the backup method.     */
  9937. /* Drop the stem to be used.                       */
  9938. Drop files.
  9939. files.0backupSet='Monday'
  9940. files.0compression='COMPRESSION'
  9941. files.0generations='3'
  9942. files.0changedFilesOnly='0'
  9943.  
  9944. /* Back up the files.                              */
  9945. Call PsnsBackupFiles handle, 'files'
  9946. Say 'PsnsBackupFiles returned' result
  9947.  
  9948. Call PsnsTerm handle
  9949. Exit
  9950.  
  9951.  
  9952. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  9953.  
  9954. /* PSnS REXX example program.                      */
  9955.  
  9956. /***************************************************/
  9957. /* Functions used:                                 */
  9958. /*       PsnsAddFile                               */
  9959. /*       PsnsPurgeFiles                            */
  9960. /*       PsnsRestoreFiles                          */
  9961. /*                                                 */
  9962. /* Restores a selection of files.                  */
  9963. /***************************************************/
  9964.  
  9965. Call RxFuncQuery 'PSNSLOADFUNCS'
  9966. If result = 1 Then Do
  9967.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  9968.    If result <> 0 Then Do
  9969.       Say "Could not load the rexxapi dll"
  9970.       Exit
  9971.    End
  9972. End
  9973. Call PSNSLOADFUNCS
  9974.  
  9975. Call PsnsInit 'handle', 'PIPE'
  9976.  
  9977. /* Empty the file list for this handle.            */
  9978. Call PsnsPurgeFiles handle
  9979. Say 'PsnsPurgeFiles returned' result
  9980.  
  9981. /* Add a file to the list.                         */
  9982. Call PsnsAddFile handle, 'D:\s\m.cmd'
  9983. Say 'PsnsAddFile returned' result
  9984.  
  9985. /* Add a directory and its contents                */
  9986. Call PsnsAddFile handle, 'D:\s\backup\'
  9987. Say 'PsnsAddFile returned' result
  9988.  
  9989. /* Add a directory and all files & directories     */
  9990. /* below it.                                       */
  9991. Call PsnsAddFile handle, 'D:\s\psnstemp\*\'
  9992. Say 'PsnsAddFile returned' result
  9993.  
  9994. /* Fill in some details for the restore method.    */
  9995. /* Drop the stem to be used.                       */
  9996. Drop files.
  9997. files.0backupSet='Monday'
  9998.  
  9999. /* Restore the files.                              */
  10000. Call PsnsRestoreFiles handle, 'files'
  10001. Say 'PsnsRestoreFiles returned' result
  10002.  
  10003. Call PsnsTerm handle
  10004. Exit
  10005.  
  10006.  
  10007. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  10008.  
  10009. /* PSnS REXX example program.                      */
  10010.  
  10011. /***************************************************/
  10012. /* Functions used:                                 */
  10013. /*       PsnsGetMessageText                        */
  10014. /*                                                 */
  10015. /* Print out the message corresponding to an API   */
  10016. /* error code.                                     */
  10017. /***************************************************/
  10018.  
  10019. Call RxFuncQuery 'PSNSLOADFUNCS'
  10020. If result = 1 Then Do
  10021.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  10022.    If result <> 0 Then Do
  10023.       Say "Could not load the rexxapi dll"
  10024.       Exit
  10025.    End
  10026. End
  10027. Call PSNSLOADFUNCS
  10028.  
  10029. Call PsnsInit 'handle', 'PIPE'
  10030.  
  10031. /* Print out the error message.                           */
  10032. Call PsnsGetMessageText handle, 'error', 45
  10033. Say 'PsnsGetMessageText returned' result
  10034. Say 'The error message is' error
  10035.  
  10036. Call PsnsTerm handle
  10037. Exit
  10038.  
  10039.  
  10040. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  10041.  
  10042. /* PSnS REXX example program.                      */
  10043.  
  10044. /***************************************************/
  10045. /* Functions used:                                 */
  10046. /*       PsnsDefaultsInfo                          */
  10047. /*       PsnsListDefaults                          */
  10048. /*                                                 */
  10049. /* Change some of the defaults, and then print out */
  10050. /* the defaults.                                   */
  10051. /***************************************************/
  10052.  
  10053. Call RxFuncQuery 'PSNSLOADFUNCS'
  10054. If result = 1 Then Do
  10055.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  10056.    If result <> 0 Then Do
  10057.       Say "Could not load the rexxapi dll"
  10058.       Exit
  10059.    End
  10060. End
  10061. Call PSNSLOADFUNCS
  10062.  
  10063. Call PsnsInit 'handle', 'PIPE'
  10064.  
  10065. /* Change some of the defaults.                    */
  10066. /* Drop the stem to be used.                       */
  10067. Drop defaults.
  10068. defaults.0generations='3'
  10069. defaults.0rulebook='A'
  10070. defaults.0backupSet='Recovery'
  10071. defaults.0fileFilter='Data'
  10072. Call PsnsDefaultsInfo handle, 'defaults'
  10073. Say 'PsnsDefaultsInfo returned' result
  10074.  
  10075. /* Print out all the defaults.                     */
  10076. /* Drop the stem to be used.                       */
  10077. Drop current.
  10078. Call PsnsListDefaults handle, 'current'
  10079. Say 'PsnsListDefaults returned' result
  10080. If result = 0 Then Do
  10081.    Say 'Default compression setting is' current.0compression
  10082.    Say 'Default number of generations is' current.0generations
  10083.    Say 'Default rulebook name is' current.0rulebook
  10084.    Say 'Default file filter name is' current.0filefilter
  10085.    Say 'Default backup set is' current.0backupSet
  10086. End
  10087.  
  10088. Call PsnsTerm handle
  10089. Exit
  10090.  
  10091.  
  10092. ΓòÉΓòÉΓòÉ <hidden> Example ΓòÉΓòÉΓòÉ
  10093.  
  10094. /* PSnS REXX example program.                      */
  10095.  
  10096. /***************************************************/
  10097. /* Functions used:                                 */
  10098. /*       PsnsListSettings                          */
  10099. /*       PsnsSettingsInfo                          */
  10100. /*                                                 */
  10101. /* Change some of the settings, and then print out */
  10102. /* the settings.                                   */
  10103. /***************************************************/
  10104.  
  10105. Call RxFuncQuery 'PSNSLOADFUNCS'
  10106. If result = 1 Then Do
  10107.    Call RxFuncAdd 'PSNSLOADFUNCS', 'PSNSREXX', 'PSNSLOADFUNCS'
  10108.    If result <> 0 Then Do
  10109.       Say "Could not load the rexxapi dll"
  10110.       Exit
  10111.    End
  10112. End
  10113. Call PSNSLOADFUNCS
  10114.  
  10115. Call PsnsInit 'handle', 'PIPE'
  10116.  
  10117. /* Change some of the settings.                    */
  10118. /* Drop the stem to be used.                       */
  10119. Drop settings.
  10120. settings.0manualPriority='HIGH'
  10121. settings.0autoPriority='HIGH'
  10122. settings.0tempPath='E:\PSNS'
  10123. settings.0flags='10001'
  10124. settings.0logFileLimit='500'
  10125. settings.0backupExit='D:\S\m.cmd'
  10126. settings.0restoreExit='D:\s\rexxipf\m.cmd'
  10127. settings.0enableACLBackup='0'
  10128. Call PsnsSettingsInfo handle, 'settings'
  10129. Say 'PsnsSettingsInfo returned' result
  10130.  
  10131. /* Print out all the settings.                     */
  10132. /* Drop the stem to be used.                       */
  10133. Drop present.
  10134. Call PsnsListSettings handle, 'present'
  10135. Say 'PsnsListSettings returned' result
  10136. If result = 0 Then Do
  10137.    Say 'Manual priority setting is' present.0manualPriority
  10138.    Say 'Auto priority setting is' present.0autoPriority
  10139.    Say 'Temporary path is' present.0tempPath
  10140.    Say 'Flags are' present.0flags
  10141.    Say 'Log file limit is' present.0logFileLimit
  10142.    Say 'Backup exit is' present.0backupExit
  10143.    Say 'Restore exit is' present.0restoreExit
  10144.    Say 'ACL Backup status is' present.0enableACLBackup
  10145. End
  10146.  
  10147. Call PsnsTerm handle
  10148. Exit
  10149.  
  10150.  
  10151. ΓòÉΓòÉΓòÉ 6. Backup methods ΓòÉΓòÉΓòÉ
  10152.  
  10153. The main way to back up files with OS/2 Warp Server Backup/Restore is by using 
  10154. backup methods. A backup method tells OS/2 Warp Server Backup/Restore which 
  10155. files you want to back up, how you want to back them up and to where you want 
  10156. to back them up.  The following sections tell you how to create, manipulate and 
  10157. run backup methods. 
  10158.  
  10159.      Working with backup methods 
  10160.  
  10161.      Running and estimating backup methods 
  10162.  
  10163.  
  10164. ΓòÉΓòÉΓòÉ 6.1. Working with backup methods ΓòÉΓòÉΓòÉ
  10165.  
  10166. You can create a backup method using the REXX API by calling the function 
  10167. PsnsCreateBackupMethod. This creates a new backup method with the given name. 
  10168. The backup method is created with default settings; you should change these 
  10169. with PsnsBackupMethodInfo to make the backup method perform the task you want. 
  10170.  
  10171. To rename, copy and delete backup methods, use the functions 
  10172. PsnsRenameBackupMethod, PsnsCopyBackupMethod and PsnsDeleteBackupMethod. 
  10173.  
  10174. To inspect or change the settings, and see descriptions of what they do, use 
  10175. the function PsnsBackupMethodInfo. This function takes as its argument a REXX 
  10176. stemname, which contains the backup method name, and the potential settings to 
  10177. change. Any compound variable which is given a value is changed. 
  10178.  
  10179. To list all the backup methods, use PsnsListBackupMethods. This works in the 
  10180. same way as all the other API listing functions. 
  10181.  
  10182.  
  10183. ΓòÉΓòÉΓòÉ 6.2. Running and estimating backup methods ΓòÉΓòÉΓòÉ
  10184.  
  10185. The main way to back up files with OS/2 Warp Server Backup/Restore is by 
  10186. running a backup method. To do this, use the function PsnsRunBackupMethod. This 
  10187. function takes as its argument the name of the backup method. 
  10188.  
  10189. To get information about how many files and folders would be backed up by a 
  10190. backup method but without actually running the backup, use 
  10191. PsnsEstimateBackupMethod. This tells OS/2 Warp Server Backup/Restore to scan 
  10192. the source drives and work out which files need to be backed up, and then 
  10193. return the results in a REXX compound variable, along with the estimated time 
  10194. for the backup, based on performance in previous backups to the same storage 
  10195. device.  Note that the first time you use a storage device, the estimated time 
  10196. will be 0 since there are no previous backups on which to base the estimate. 
  10197.  
  10198.  
  10199. ΓòÉΓòÉΓòÉ 7. Restore methods ΓòÉΓòÉΓòÉ
  10200.  
  10201. The main way to restore files with OS/2 Warp Server Backup/Restore is by using 
  10202. restore methods. A backup method tells OS/2 Warp Server Backup/Restore which 
  10203. files you want to restore, to where you want to restore them, and how to choose 
  10204. which generation will be restored. The following sections tell you how to 
  10205. create, manipulate and run restore methods. 
  10206.  
  10207.      Working with restore methods 
  10208.  
  10209.      Running and estimating restore methods 
  10210.  
  10211.  
  10212. ΓòÉΓòÉΓòÉ 7.1. Working with restore methods ΓòÉΓòÉΓòÉ
  10213.  
  10214. You can create a restore method using the REXX API by calling the function 
  10215. PsnsCreateRestoreMethod. This creates a new restore method with the given name. 
  10216. The restore method is created with default settings; you should change these 
  10217. with PsnsRestoreMethodInfo to make the restore method perform the task you 
  10218. want. 
  10219.  
  10220. To rename, copy and delete restore methods, use the functions 
  10221. PsnsRenameRestoreMethod, PsnsCopyRestoreMethod and PsnsDeleteRestoreMethod. 
  10222.  
  10223. To inspect or change the settings, and see descriptions of what they do, use 
  10224. the function PsnsRestoreMethodInfo. This function takes as its argument a REXX 
  10225. stemname, which contains the restore method name, and the potential settings to 
  10226. change. Any compound variable which is given a value is changed. 
  10227.  
  10228. To list all the restore methods, use PsnsListRestoreMethods. This works in the 
  10229. same way as all the other API listing functions. 
  10230.  
  10231.  
  10232. ΓòÉΓòÉΓòÉ 7.2. Running and estimating restore methods ΓòÉΓòÉΓòÉ
  10233.  
  10234. The main way to restore files with OS/2 Warp Server Backup/Restore is by 
  10235. running a restore method. To do this, use the function PsnsRunRestoreMethod. 
  10236. This function takes as its argument the name of the restore method. 
  10237.  
  10238. To get information about how many files and folders would be restored by a 
  10239. restore method but without actually running the restore, use 
  10240. PsnsEstimateRestoreMethod. This tells OS/2 Warp Server Backup/Restore to scan 
  10241. the backup set and work out which files would need to be restored, and then 
  10242. return the results in a REXX compound variable, along with the estimated time 
  10243. for the restore, based on performance in previous restores to the same storage 
  10244. device.  Note that the first time you use a storage device, the estimated time 
  10245. will be 0 since there are no previous restores on which to base the estimate. 
  10246.  
  10247.  
  10248. ΓòÉΓòÉΓòÉ 8. Backup sets ΓòÉΓòÉΓòÉ
  10249.  
  10250. A backup set is where data is stored by OS/2 Warp Server Backup/Restore  A 
  10251. backup set is associated with a particular storage device and may contain more 
  10252. than one physical volume of backed-up data.  The following section tell you how 
  10253. to create and manipulate backup sets. 
  10254.  
  10255.      Working with backup sets 
  10256.  
  10257.  
  10258. ΓòÉΓòÉΓòÉ 8.1. Working with backup sets ΓòÉΓòÉΓòÉ
  10259.  
  10260. You can create a backup set with the REXX API by calling the function 
  10261. PsnsCreateBackupSet. You must specify a storage device with which to associate 
  10262. the backup set. The backup set is created with a default configuration, which 
  10263. should be sufficient in most cases. 
  10264.  
  10265. To delete a backup set, use PsnsDeleteBackupSet. 
  10266.  
  10267. Note:  When you delete a backup set, all backed-up data on it is lost! 
  10268.  
  10269. To empty the backup set of data without deleting the backup set itself, use 
  10270. PsnsEmptyBackupSet. 
  10271.  
  10272. To change the description of a backup set, or to inspect the description and 
  10273. find out what storage device it is associated with, use PsnsBackupSetInfo. 
  10274. This function takes as its argument a REXX stemname, which contains the 
  10275. potential settings to change. 
  10276.  
  10277. Other backup set settings depend on the storage device which the backup set 
  10278. uses, and so are set and queried using a configuration string.  Use the 
  10279. functions PsnsGetBackupSetConfig and PsnsSetBackupSetConfig to get and set the 
  10280. configuration string for a backup set.  For more information, see Storage 
  10281. Device configuration. 
  10282.  
  10283. To list all the backup sets, use PsnsListBackupSets. This works in the same way 
  10284. as all the other API listing functions. 
  10285.  
  10286. Backup sets can be transferred out, which means that OS/2 Warp Server 
  10287. Backup/Restore writes all index data to the backup set media and then will not 
  10288. use the backup set for any more backups or restores until it is transferred in 
  10289. again.  This is useful for moving backup sets between machines, for example. 
  10290. To transfer a backup set in or out, use PsnsTransferBackupSet. This function 
  10291. takes as arguments the name of the backup set and a flag specifying whether the 
  10292. backup set is to be transferred in or out.  In order to transfer in a 
  10293. "forgotten" backup set, use the function PsnsTransferIn. 
  10294.  
  10295. Each backup set has a log file which is a text file containing a log of 
  10296. activity performed on that backup set.  To find the name of the log file for a 
  10297. backup set, use the function PsnsGetLogFile.  You can then, for example, view, 
  10298. process or delete the log file. 
  10299.  
  10300. Dual device backup sets can be also be created with the PsnsCreateBackupSet 
  10301. function.  These allow you to perform an initial backup to one storage device, 
  10302. then further backups to an incremental device.  The storage device to which you 
  10303. perform the initial backup is known as the base device.  You may specify the 
  10304. virtual device only as the base storage device of a dual device backup set. 
  10305.  
  10306.  
  10307. ΓòÉΓòÉΓòÉ 9. Storage devices ΓòÉΓòÉΓòÉ
  10308.  
  10309. Storage devices are the physical systems OS/2 Warp Server Backup/Restore uses 
  10310. to store backed-up data, such as tape drives, hard disks or ADSM servers.  The 
  10311. following sections tell you how to create and manipulate storage devices. 
  10312.  
  10313.      Creating a storage device 
  10314.  
  10315.      Working with storage devices 
  10316.  
  10317.  
  10318. ΓòÉΓòÉΓòÉ 9.1. Creating a storage device ΓòÉΓòÉΓòÉ
  10319.  
  10320. When a new storage device is created, it must be one of a number of available 
  10321. types; these are the names which appear when you select 'New' from the pop-up 
  10322. menu in the Storage Devices container in the OS/2 Warp Server Backup/Restore 
  10323. user interface.  To accomplish this using the API, you can find out the 
  10324. available types of storage devices to create by calling 
  10325. PsnsListCreatableStorageDevices. This will list all creatable storage devices 
  10326. You can then call PsnsCreateStorageDevice which takes as an argument the name 
  10327. of the creatable storage device from which to create the new storage device. 
  10328. You must also specify a configuration string when you create a storage device, 
  10329. since there are some configuration options which can only be specified when a 
  10330. device is created and cannot be changed afterwards; for more information see 
  10331. Storage Device configuration. 
  10332.  
  10333.  
  10334. ΓòÉΓòÉΓòÉ 9.2. Working with storage devices ΓòÉΓòÉΓòÉ
  10335.  
  10336. Storage device settings depend on the individual storage device, so they are 
  10337. set using a configuration string.  For more information on configuration 
  10338. strings, see Storage Device configuration.  Use the functions 
  10339. PsnsGetStorageDeviceConfig and PsnsSetStorageDeviceConfig to get and set the 
  10340. storage device configuration. 
  10341.  
  10342. To find out which Dynamic Link Library (DLL) file a storage device uses, call 
  10343. PsnsStorageDeviceInfo. This function takes as its argument a REXX stemname, 
  10344. into which the DLL name is put. 
  10345.  
  10346. To list all the storage devices, use PsnsListStorageDevices. This works in the 
  10347. same way as all the other API listing functions. 
  10348.  
  10349. OS/2 Warp Server Backup/Restore usually scans for new storage devices 
  10350. automatically when it is started up.  To perform this task manually, use the 
  10351. function PsnsRefreshStorageDevices. 
  10352.  
  10353.  
  10354. ΓòÉΓòÉΓòÉ 10. Volumes ΓòÉΓòÉΓòÉ
  10355.  
  10356. Volumes are the individual tapes, diskettes or cartridges on which backed-up 
  10357. data is stored.  OS/2 Warp Server Backup/Restore keeps track of which files are 
  10358. stored on which volumes, and how much space is used up on each volume; this 
  10359. means that the user does not have to worry about remembering exactly where 
  10360. their data is.  The following section tells you how to create and manipulate 
  10361. volumes. 
  10362.  
  10363.      Working with volumes 
  10364.  
  10365.  
  10366. ΓòÉΓòÉΓòÉ 10.1. Working with volumes ΓòÉΓòÉΓòÉ
  10367.  
  10368. Volumes are referred to by their volume ID, which is an unsigned long integer. 
  10369.  
  10370. Creating a volume involves formatting and labelling the volume.  Before you can 
  10371. create a volume using the API, you should ensure that the correct tape or 
  10372. diskette is already in the drive.  When creating a volume under the graphical 
  10373. environment, the user is asked to insert the correct tape or diskette before 
  10374. formatting, but since this cannot be done when running under the API it is 
  10375. assumed that the correct media is already in the drive. To create a volume, 
  10376. call the function PsnsCreateVolume. 
  10377.  
  10378. Note:  Creating a volume will erase all data from the media currently in the 
  10379. drive. 
  10380.  
  10381. You should not have an existing volume in the drive when you call this 
  10382. function; always empty the backup set or delete the volume if you wish to 
  10383. re-use it. 
  10384.  
  10385. To delete a volume, use the function PsnsDeleteVolume.  This will make OS/2 
  10386. Warp Server Backup/Restore forget about all backed-up data on the volume.  You 
  10387. should not use this function as a regular part of your storage management, but 
  10388. only in circumstances such as when you have lost a tape and want to let OS/2 
  10389. Warp Server Backup/Restore know this. 
  10390.  
  10391. To get information about a volume, use PsnsVolumeInfo.  This takes as arguments 
  10392. a volume ID and a REXX stemname. Information about the volume and its space 
  10393. usage is returned in REXX compound variables. 
  10394.  
  10395. To list volumes and to list backup sets on a volume, use the functions 
  10396. PsnsListVolumes and PsnsListVolumeBackupSets. These work in the same way as the 
  10397. other API listing functions. 
  10398.  
  10399. It is possible to deactivate a volume; in this state, the volume will not be 
  10400. used for backups or restores.  You could do this if the volume is unavailable 
  10401. and you do not want OS/2 Warp Server Backup/Restore to request it when 
  10402. performing a backup.  To deactivate or activate a volume, use the function 
  10403. PsnsActivateVolume. 
  10404.  
  10405. When a volume is first created, it is not associated with any particular backup 
  10406. set and so will not be used for backup.  Before the volume can be used, you 
  10407. must associate it with a backup set; this can be done with the API by calling 
  10408. PsnsAssociateVolume. 
  10409.  
  10410.  
  10411. ΓòÉΓòÉΓòÉ 11. Events ΓòÉΓòÉΓòÉ
  10412.  
  10413. OS/2 Warp Server Backup/Restore allows you to schedule events which will run a 
  10414. backup method at a particular time.  The following section tells you how to 
  10415. create and manipulate scheduled events. 
  10416.  
  10417.      Working with events 
  10418.  
  10419.  
  10420. ΓòÉΓòÉΓòÉ 11.1. Working with events ΓòÉΓòÉΓòÉ
  10421.  
  10422. There are five different types of scheduled events in OS/2 Warp Server 
  10423. Backup/Restore: 
  10424.  
  10425.      Interval or regular events.  These events happen at regular intervals in 
  10426.       time, for example every hour or every ten minutes. 
  10427.  
  10428.      Daily events.  These happen at a certain time each day. 
  10429.  
  10430.      Monthly events.  These happen at a certain time on a certain day of each 
  10431.       month. 
  10432.  
  10433.      Named day(s) events.  These happen at a certain time on some days of each 
  10434.       month.  You can select individually on which days of the week and in 
  10435.       which weeks of the month the event will occur. 
  10436.  
  10437.      Startup events.  These occur a fixed time after starting up OS/2 Warp 
  10438.       Server Backup/Restore. 
  10439.  
  10440.  Events are referred to by an event ID, which is an unsigned short integer. 
  10441.  They do not have names. 
  10442.  
  10443.  To create an event, call PsnsCreateEvent.  You must specify the type of the 
  10444.  event and the name of a backup method.  The backup method can be changed later 
  10445.  but you must supply one when creating an event since there is no sensible 
  10446.  default option.  A new event ID will be created and returned. 
  10447.  
  10448.  To delete an event, use PsnsDeleteEvent. 
  10449.  
  10450.  To copy an event, use PsnsCopyEvent. A new event ID will be created and 
  10451.  returned. 
  10452.  
  10453.  To get or set the information about an event, use PsnsEventInfo. This function 
  10454.  takes as arguments an event ID, and a REXX stemname. Any compound variable 
  10455.  that is given a value, will be changed. For more information, see 
  10456.  PsnsEventInfo. 
  10457.  
  10458.  To list all the event, use PsnsListEvents. This works in the same way as the 
  10459.  other API listing functions. 
  10460.  
  10461.  To find out which event is due to occur next, use PsnsGetNextEvent. 
  10462.  
  10463.  Events can be deactivated so that they will not occur; for example, you may 
  10464.  want to deactivate a regular backup during a holiday or during system 
  10465.  maintenance.  To activate or deactivate an event, use the function 
  10466.  PsnsActivateEvent. 
  10467.  
  10468.  
  10469. ΓòÉΓòÉΓòÉ 12. File filters ΓòÉΓòÉΓòÉ
  10470.  
  10471. File filters allow you to automatically select files to be backed up.  The 
  10472. following section tells you how to create and manipulate file filters. 
  10473.  
  10474.      Working with file filters 
  10475.  
  10476.      Working with file filter rules 
  10477.  
  10478.  
  10479. ΓòÉΓòÉΓòÉ 12.1. Working with file filters ΓòÉΓòÉΓòÉ
  10480.  
  10481. In the OS/2 Warp Server Backup/Restore graphical user interface, there are two 
  10482. types of file filters: tree-based and rule-based filters.  In fact all file 
  10483. filters are stored internally as rule-based filters, so this is how they are 
  10484. accessed using the API. 
  10485.  
  10486. To create a file filter, use the function PsnsCreateFileFilter.  You must 
  10487. specify a name for the file filter and the type of the filter.  The type you 
  10488. specify only changes how the file filter is edited under the graphical user 
  10489. interface; it does not alter how the file filter appears under the API.  The 
  10490. file filter is created with one rule in it; this is the 'last' rule which 
  10491. matches all files not matched by any other rules. 
  10492.  
  10493. To delete, rename and copy file filters, use the functions 
  10494. PsnsDeleteFileFilter, PsnsRenameFileFilter and PsnsCopyFileFilter. 
  10495.  
  10496. To inspect or change the settings of a file filter, use the function 
  10497. PsnsFileFilterInfo. This function takes as its argument a stemname. Any 
  10498. compound variable which is given a value is changed. 
  10499.  
  10500. To list all the file filters , use PsnsListFileFilters. This works in the same 
  10501. way as the other API listing functions. 
  10502.  
  10503.  
  10504. ΓòÉΓòÉΓòÉ 12.2. Working with file filter rules ΓòÉΓòÉΓòÉ
  10505.  
  10506. A file filter rule specifies which files it matches and whether they should be 
  10507. included or excluded from the backup.  When a file is tested to see whether it 
  10508. should be backed up or not, it is matched against all of the rules in turn, 
  10509. starting from the first one.  When a rule is found which matches the file, that 
  10510. rule is used to decide whether the file should be backed up or not. 
  10511.  
  10512. Every file filter contains one rule, which is always last, which matches all 
  10513. files not selected by any other rules.  You cannot delete this rule or change 
  10514. it except to change whether the files are to be included or excluded. 
  10515.  
  10516. To add a rule to a file filter, use PsnsAddFileFilterRule.  This takes as 
  10517. arguments the name of a file filter, a REXX stemnanme, and an integer which 
  10518. specifies where in the file filter the rule is to be added; use 1 to add the 
  10519. rule at the top of the list of rules in the file filter, 2 to add it in second 
  10520. place and so on. 
  10521.  
  10522. To delete a rule from a file filter, use PsnsDeleteFileFilterRule.  You cannot 
  10523. delete the 'last' rule in a file filter. To inspect or change the settings for 
  10524. a file filter rule, use the function PsnsFileFilterRuleInfo. This function 
  10525. takes as arguments a file filter name, a REXX stemname and an integer mask. Any 
  10526. compound variable which is given a value is changed. For more information, see 
  10527. PsnsFileFilterRuleInfo. 
  10528.  
  10529.  
  10530. ΓòÉΓòÉΓòÉ 13. Rulebooks ΓòÉΓòÉΓòÉ
  10531.  
  10532. Rulebooks allow you to use rules to decide how many generations of a file 
  10533. should be backed up and whether or not compression should be used.  The 
  10534. following section tells you how to create and manipulate rulebooks. 
  10535.  
  10536.      Working with rulebooks 
  10537.  
  10538.      Working with rulebook rules 
  10539.  
  10540.  
  10541. ΓòÉΓòÉΓòÉ 13.1. Working with rulebooks ΓòÉΓòÉΓòÉ
  10542.  
  10543. To create a rulebook, use the function PsnsCreateRulebook. The rulebook is 
  10544. created with one rule in it; this is the 'last' rule which matches all files 
  10545. not matched by any other rules. 
  10546.  
  10547. To delete, rename and copy rulebooks, use the functions PsnsDeleteRulebook, 
  10548. PsnsRenameRulebook and PsnsCopyRulebook. 
  10549.  
  10550. To inspect or change the settings, use the function PsnsRulebookInfo. This 
  10551. function takes as its argument a REXX stemname. Any compound variable which is 
  10552. given a value is changed. For more information, see PsnsRulebookInfo. 
  10553.  
  10554. To list all the rulebooks , use PsnsListRulebooks. This works in the same way 
  10555. as the other API listing functions. 
  10556.  
  10557.  
  10558. ΓòÉΓòÉΓòÉ 13.2. Working with rulebook rules ΓòÉΓòÉΓòÉ
  10559.  
  10560. A rulebook rule specifies which files it matches, how many generations to keep 
  10561. and whether or not compression should be performed on the files. When a file is 
  10562. tested to see whether it should be backed up or not, it is matched against all 
  10563. of the rules in turn, starting from the first one.  When a rule is found which 
  10564. matches the file, that rule is used to decide the number of generations and 
  10565. compression to use for that file. 
  10566.  
  10567. Every rulebook contains one rule, which is always last, which matches all files 
  10568. not selected by any other rules.  You cannot delete this rule or change it 
  10569. except to change the number of generations and compression. 
  10570.  
  10571. To add a rule to a rulebook, use PsnsAddRulebookRule.  This takes as arguments 
  10572. the name of a rulebook, a REXX stemname, and an integer which specifies where 
  10573. in the rulebook the rule is to be added; use 1 to add the rule at the top of 
  10574. the list of rules in the rulebook, 2 to add it in second place and so on. 
  10575.  
  10576. To delete a rule from a rulebook, use PsnsDeleteRulebookRule.  You cannot 
  10577. delete the 'last' rule in a rulebook. To inspect or change the settings for a 
  10578. rulebook rule, use the function PsnsRulebookRuleInfo. This function takes as 
  10579. arguments a rulebook name, a REXX stemname, and an integer which specifies 
  10580. which rule to look at. Any compound variable which is given a value is changed. 
  10581. For more information, see PsnsRulebookRuleInfo. 
  10582.  
  10583.  
  10584. ΓòÉΓòÉΓòÉ 14. Source drives ΓòÉΓòÉΓòÉ
  10585.  
  10586. OS/2 Warp Server Backup/Restore keeps a list of all drives on your system to 
  10587. decide where it should look for files to back up.  The following section tells 
  10588. you how to manipulate source drives. 
  10589.  
  10590.      Working with source drives 
  10591.  
  10592.  
  10593. ΓòÉΓòÉΓòÉ 14.1. Working with source drives ΓòÉΓòÉΓòÉ
  10594.  
  10595. OS/2 Warp Server Backup/Restore keeps a list of all drives on your system. 
  10596. When you do a backup which specifies that files should be backed up from all 
  10597. drives, this list is used to decide which drives should be checked for files to 
  10598. back up.  For example, you might want to back up files from your local hard 
  10599. disks but not from your network drives. 
  10600.  
  10601. To list all the source drives which OS/2 Warp Server Backup/Restore knows 
  10602. about, use PsnsListSourceDrives.  This works in the same way as the other API 
  10603. listing functions. 
  10604.  
  10605. To select or deselect a source drive for backup, use PsnsSelectSourceDrive. 
  10606.  
  10607. When you start up OS/2 Warp Server Backup/Restore, it scans to see what drives 
  10608. are attached to your system.  To do this again manually, use the function 
  10609. PsnsRefreshSourceDrives.  To change the type of a source drive if it has been 
  10610. incorrectly detected, use PsnsSourceDriveType. 
  10611.  
  10612.  
  10613. ΓòÉΓòÉΓòÉ 15. Files ΓòÉΓòÉΓòÉ
  10614.  
  10615. The following two sections tell you about dealing with individual files. 
  10616.  
  10617.      Working with backed-up data 
  10618.  
  10619.      Working with lists of individual files 
  10620.  
  10621.  
  10622. ΓòÉΓòÉΓòÉ 15.1. Working with backed-up data ΓòÉΓòÉΓòÉ
  10623.  
  10624. Data is stored in a backup set as a series of generations of files.  Each time 
  10625. you back up a file, a new generation is created, and an old generation might be 
  10626. dropped. 
  10627.  
  10628. While you are listing backed-up data, you cannot perform any other operations 
  10629. on the backup set; you must wait until the listing operation is finished. 
  10630.  
  10631. To remove files from the backup set, use PsnsDropFiles. 
  10632.  
  10633.  
  10634. ΓòÉΓòÉΓòÉ 15.2. Working with lists of individual files ΓòÉΓòÉΓòÉ
  10635.  
  10636. In addition to backing up and restoring files using backup methods and restore 
  10637. methods, it is also possible to back up or restore a specific list of files; 
  10638. this is useful for working with individual files on a one-off basis. If, 
  10639. however, you plan to back up or restore the same files regularly, you should 
  10640. use a backup or restore method. 
  10641.  
  10642. To perform operations on a list of files, you must first tell OS/2 Warp Server 
  10643. Backup/Restore whicb files you want to work on.  To do this, call PsnsAddFile 
  10644. once for every file or group of files you want to add to the list.  This does 
  10645. not actually do anything to the files, it simply remembers them.  Afterwards, 
  10646. use PsnsBackupFiles, PsnsRestoreFiles or PsnsDropFiles to work with the files. 
  10647.  
  10648. To empty the list without performing any operations on the files, use 
  10649. PsnsPurgeFiles. 
  10650.  
  10651.  
  10652. ΓòÉΓòÉΓòÉ 16. Object names ΓòÉΓòÉΓòÉ
  10653.  
  10654. Object names in OS/2 Warp Server Backup/Restore can contain any printable text 
  10655. character, except that: 
  10656.  
  10657.      They may not begin with a space 
  10658.  
  10659.      They may not begin with a < (less than) sign 
  10660.  
  10661.      They must be at least one character long 
  10662.  
  10663.  
  10664. ΓòÉΓòÉΓòÉ 17. Wildcards ΓòÉΓòÉΓòÉ
  10665.  
  10666. Some fields, especially when searching for objects in OS/2 Warp Server 
  10667. Backup/Restore, may contain wildcards. When searching for object names and any 
  10668. other string apart from fully qualified filenames, the asterisk character (*) 
  10669. may be used to match any sequence of characters. 
  10670.  
  10671. In fully qualified filenames, wildcards may be used as follows: 
  10672.  
  10673.      The drive letter may be *, which means look for files on all drives. 
  10674.  
  10675.      The path may end with \*\, meaning look in all subdirectories of the 
  10676.       named directory. 
  10677.  
  10678.      The filename may contain one or more asterisks (*) which act as usual 
  10679.       wildcards. 
  10680.  
  10681.  
  10682. ΓòÉΓòÉΓòÉ 18. Listing functions ΓòÉΓòÉΓòÉ
  10683.  
  10684. There are many functions in the OS/2 Warp Server Backup/Restore API for listing 
  10685. objects of various sorts. They all work in a similar way: 
  10686.  
  10687.      Each function that needs data returned to it is called with a REXX 
  10688.       stemname, it is into this stemname that the information will be put. The 
  10689.       API attaches, onto the end of the stemname, a period (.), then a number 
  10690.       referring to which number in the list that item is, another period (.), 
  10691.       and then the name of the item being returned.  This leaves the user, with 
  10692.       something like this: 
  10693.  
  10694.             stemname.2.0description
  10695.  
  10696.       The value can then be printed out from REXX, and loops set up to look at 
  10697.       all the components. To aid this, the number of items in each list, is 
  10698.       returned in stemname.0. The name of the return item is preceded by a 0, 
  10699.       so that it is not mistaken for a REXX variable. 
  10700.  
  10701.  
  10702. ΓòÉΓòÉΓòÉ 19. Storage device and backup set configuration ΓòÉΓòÉΓòÉ
  10703.  
  10704. The configuration of storage devices and backup sets is done by means of 
  10705. configuration strings, the contents of which are specific to the storage 
  10706. device. A configuration string consists of a series of keywords and values, 
  10707. separated by semicolons (;), for example: 
  10708.  
  10709. BEEP=YES;VERIFY=NO;
  10710.  
  10711. The caret (^) can be used as an escape character if either semicolons or equals 
  10712. signs are required in a value. A value may also be enclosed in either single or 
  10713. double quotation marks; the caret can be used as an escape character if a 
  10714. quotation mark is required within a quoted string. A value must be enclosed in 
  10715. quotation marks if leading or trailing space characters are required. In order 
  10716. to include a caret in a value, 2 consecutive caret characters should be used. 
  10717.  
  10718. Storage devices require a configuration string when they are created with 
  10719. PsnsCreateStorageDevice; once created, their configuration string can be 
  10720. obtained with PsnsGetStorageDeviceConfig. Some storage devices, for example the 
  10721. ADSM device,  can be reconfigured, using PsnsSetStorageDeviceConfig. 
  10722.  
  10723. It is possible to supply a configuration string when creating a backup set 
  10724. using PsnsCreateBackupSet, but this is optional. Once created, a backup set's 
  10725. configuration string can be obtained with PsnsGetBackupSetConfig; backup sets 
  10726. on some types of storage device may be reconfigured using 
  10727. PsnsSetBackupSetConfig. 
  10728.  
  10729. The following sections describe the format of configuration strings for the 
  10730. standard storage devices. 
  10731.  
  10732.  
  10733. ΓòÉΓòÉΓòÉ 19.1. SCSI tape storage devices ΓòÉΓòÉΓòÉ
  10734.  
  10735. These sections describe configuration strings for SCSI tape storage devices and 
  10736. backup sets. 
  10737.  
  10738.      Storage device configuration 
  10739.  
  10740.      Backup set configuration 
  10741.  
  10742.  
  10743. ΓòÉΓòÉΓòÉ 19.1.1. Storage device configuration ΓòÉΓòÉΓòÉ
  10744.  
  10745. The following keywords are supported: 
  10746.  
  10747.       ADAPTER 
  10748.  
  10749.       Meaning        The number of the SCSI adapter to which the tape drive is 
  10750.                      attached. 
  10751.       Valid values   A valid SCSI adapter number. 
  10752.  
  10753.       This keyword must be supplied when creating a storage device. 
  10754.  
  10755.       PUN 
  10756.  
  10757.       Meaning        The SCSI Physical Unit Number (PUN) of the tape drive. 
  10758.       Valid values   A valid PUN. 
  10759.  
  10760.       This keyword must be supplied when creating a storage device. 
  10761.  
  10762.  For example: 
  10763.  
  10764.   PsnsCreateStorageDevice handle, "SCSI tape drive", "ADAPTER=2;PUN=3;"
  10765.  
  10766.  SCSI tape storage devices cannot be reconfigured. 
  10767.  
  10768.  
  10769. ΓòÉΓòÉΓòÉ 19.1.2. Backup set configuration ΓòÉΓòÉΓòÉ
  10770.  
  10771. The following keywords are supported: 
  10772.  
  10773.       CHECKDRIVE 
  10774.  
  10775.       Meaning        If you select this option then OS/2 Warp Server 
  10776.                      Backup/Restore will check the drive for a suitable volume 
  10777.                      before it prompts you to insert a tape. This option is 
  10778.                      useful when you are performing unattended backups. 
  10779.       Valid values   YES or NO 
  10780.  
  10781.       This keyword is optional when creating a backup set: if it is absent, the 
  10782.       user will always be prompted to insert a tape, even if the required 
  10783.       volume is already in the drive. 
  10784.  
  10785.       BEEP 
  10786.  
  10787.       Meaning        Whether OS/2 Warp Server Backup/Restore should make a 
  10788.                      noise when it asks for a tape volume to be inserted. 
  10789.       Valid values   YES or NO 
  10790.  
  10791.       This keyword is optional when creating a backup set: if it is absent, a 
  10792.       noise will not be made. 
  10793.  
  10794.  For example: 
  10795.  
  10796.   PsnsSetBackupSetConfig handle, "niceName", "CHECKDRIVE=YES;BEEP=NO;"
  10797.  
  10798.  SCSI tape backup sets can be reconfigured. 
  10799.  
  10800.  
  10801. ΓòÉΓòÉΓòÉ 19.2. Diskette and RW optical storage devices ΓòÉΓòÉΓòÉ
  10802.  
  10803. These sections describe configuration strings for diskette and RW optical 
  10804. storage devices and backup sets. 
  10805.  
  10806.      Storage device configuration 
  10807.  
  10808.      Backup set configuration 
  10809.  
  10810.  
  10811. ΓòÉΓòÉΓòÉ 19.2.1. Storage device configuration ΓòÉΓòÉΓòÉ
  10812.  
  10813. The following keywords are supported: 
  10814.  
  10815.       DRIVE 
  10816.  
  10817.       Meaning        The letter of the drive which the storage device is to use 
  10818.                      for backup. 
  10819.       Valid values   A drive letter. 
  10820.  
  10821.       This keyword must be supplied when creating a storage device. 
  10822.  
  10823.       INDEXDRIVE (Optical only) 
  10824.  
  10825.       Meaning        The letter of the drive which the storage device is to use 
  10826.                      to back up index files. 
  10827.       Valid values   A diskette drive letter. 
  10828.  
  10829.       This keyword is optional when creating a storage device: if it is absent, 
  10830.       drive A will be used. 
  10831.  
  10832.  For example: 
  10833.  
  10834.   PsnsCreateStorageDevice handle, "RW Optical", "DRIVE=F;INDEXDRIVE=A"
  10835.  
  10836.  Diskette and RW optical storage devices cannot be reconfigured. 
  10837.  
  10838.  
  10839. ΓòÉΓòÉΓòÉ 19.2.2. Backup set configuration ΓòÉΓòÉΓòÉ
  10840.  
  10841. The following keywords are supported: 
  10842.  
  10843.       BACKUPINDEX 
  10844.  
  10845.       Meaning        Whether OS/2 Warp Server Backup/Restore should 
  10846.                      automatically back up its index files using index 
  10847.                      diskettes. 
  10848.       Valid values   YES or NO 
  10849.  
  10850.       This keyword is optional when creating a backup set: if it is absent, 
  10851.       index files will be backed up. 
  10852.  
  10853.       BEEP 
  10854.  
  10855.       Meaning        Whether OS/2 Warp Server Backup/Restore should make a 
  10856.                      noise when it asks for a diskette or RW optical disk to be 
  10857.                      inserted. 
  10858.       Valid values   YES or NO 
  10859.  
  10860.       This keyword is optional when creating a backup set: if it is absent, a 
  10861.       noise will be made. 
  10862.  
  10863.       VERIFY 
  10864.  
  10865.       Meaning        Whether OS/2 Warp Server Backup/Restore should confirm 
  10866.                      that the data written to diskette or RW optical disk is 
  10867.                      correct. 
  10868.       Valid values   YES or NO 
  10869.  
  10870.       This keyword is optional when creating a backup set: if it is absent, 
  10871.       backups will be verified. 
  10872.  
  10873.  For example: 
  10874.  
  10875.   PsnsSetBackupSetConfig handle, "niceName", "BEEP=NO;VERIFY=YES"
  10876.  
  10877.  Diskette and RW optical backup sets can be reconfigured. 
  10878.  
  10879.  
  10880. ΓòÉΓòÉΓòÉ 19.3. ADSM storage devices ΓòÉΓòÉΓòÉ
  10881.  
  10882. These sections describe configuration strings for ADSM storage devices and 
  10883. backup sets. 
  10884.  
  10885. Note:  ADSM storage devices cannot be created using PsnsCreateStorageDevice. 
  10886. Instead one is automatically created on installation, and this can then be 
  10887. edited if necessary. 
  10888.  
  10889.      Storage device configuration 
  10890.  
  10891.      Updating the ADSM options file 
  10892.  
  10893.      Backup set configuration 
  10894.  
  10895.  
  10896. ΓòÉΓòÉΓòÉ 19.3.1. Storage device configuration ΓòÉΓòÉΓòÉ
  10897.  
  10898. The following keywords are supported: 
  10899.  
  10900.       OPTIONSFILE 
  10901.  
  10902.       Meaning        The name of the ADSM options file to be used when 
  10903.                      connecting to the ADSM server, or the name of the file to 
  10904.                      be used to set the initial values for the ADSM options 
  10905.                      file when the NEWOPTIONSFILE keyword is also specified. 
  10906.                      The ADSM options file must exist and contain valid options 
  10907.                      before a connection with the ADSM server may be 
  10908.                      successfully established. The options file may be updated 
  10909.                      using special keywords in the configuration string. 
  10910.       Valid values   The name of an existing ADSM options file. 
  10911.  
  10912.       This keyword is optional.  If it is absent when creating the storage 
  10913.       device, a default file name will be used. If it is absent when updating 
  10914.       the storage device, the name of the options file will not be changed. 
  10915.  
  10916.       NEWOPTIONSFILE 
  10917.  
  10918.       Meaning        The name of the ADSM options file to be used when 
  10919.                      connecting to the ADSM server. The file will be created if 
  10920.                      it does not already exist; any existing file of the same 
  10921.                      name will be replaced. 
  10922.  
  10923.                      The initial option values for the new options file depend 
  10924.                      on the value of the OPTIONSFILE keyword: 
  10925.  
  10926.                      OPTIONSFILE=filename 
  10927.  
  10928.                                     The initial values will be taken from 
  10929.                                     filename. 
  10930.  
  10931.                      OPTIONSFILE= 
  10932.  
  10933.                                     There will be no initial values. 
  10934.  
  10935.                      OPTIONSFILE not specified 
  10936.  
  10937.                                     The initial values will be taken from the 
  10938.                                     options file specified in the existing ADSM 
  10939.                                     storage device settings. 
  10940.  
  10941.                      Values in the options file may be set or updated using 
  10942.                      special keywords in the configuration string. 
  10943.  
  10944.       Valid values   A valid file name 
  10945.  
  10946.       This keyword is optional.  If it is absent, the name of the ADSM options 
  10947.       file to be used is determined by the value of the OPTIONSFILE keyword and 
  10948.       no new options file will be created. 
  10949.  
  10950.       NODENAME 
  10951.  
  10952.       Meaning        The node name to be used for connection to the ADSM 
  10953.                      server. 
  10954.       Valid values   A valid ADSM node name; this node name must be registered 
  10955.                      at the ADSM server before a connection may be successfully 
  10956.                      established. 
  10957.  
  10958.       This keyword is optional.  If it is absent when creating the storage 
  10959.       device, a default node name will be used. If it is absent when updating 
  10960.       the storage device, the node name will not be changed. 
  10961.  
  10962.       MGMTCLASS 
  10963.  
  10964.       Meaning        This is the ADSM management class to be used for backing 
  10965.                      up objects from OS/2 Warp Server Backup/Restore. This 
  10966.                      management class must be known at the ADSM server to which 
  10967.                      you will connect, and must be defined within the active 
  10968.                      policy set of the policy domain which is associated with 
  10969.                      your node. 
  10970.  
  10971.                      If you do not specify a management class, or if the 
  10972.                      management class is not defined within your active policy 
  10973.                      set, the default management class for your node will be 
  10974.                      used. 
  10975.  
  10976.                      If you set the management class to be mgmt_class,  a 
  10977.                      statement of the form: 
  10978.  
  10979.                                           INCLUDE * mgmt_class
  10980.                      is inserted into your ADSM options file. 
  10981.  
  10982.       Valid values   A valid ADSM management class name. 
  10983.  
  10984.       This keyword is optional.  If it is absent when creating the storage 
  10985.       device, the default management class for your node will be used. If it is 
  10986.       absent when updating the storage device, the management class name will 
  10987.       not be changed. 
  10988.  
  10989.       MAXOBJECTS 
  10990.  
  10991.       Meaning        When OS/2 Warp Server Backup/Restore is backing up objects 
  10992.                      to an ADSM server, several objects may be sent to ADSM in 
  10993.                      a single batch; each batch is a single ADSM transaction. 
  10994.                      Each object (file or directory) that you back up using 
  10995.                      OS/2 Warp Server Backup/Restore may actually be stored in 
  10996.                      ADSM as several ADSM objects; for example, if a file has 
  10997.                      extended attributes, the file and its extended attributes 
  10998.                      may actually be stored as 2 separate ADSM objects. You can 
  10999.                      use this setting to limit the number of OS/2 Warp Server 
  11000.                      Backup/Restore objects that are included in a batch (the 
  11001.                      corresponding number of ADSM objects may be greater). 
  11002.  
  11003.                      Note:  ADSM also has a limit on the number of its objects 
  11004.                      that can be stored in a single transaction. The number of 
  11005.                      OS/2 Warp Server Backup/Restore objects actually sent in a 
  11006.                      batch will be less than the number specified by MAXOBJECTS 
  11007.                      if the corresponding number of ADSM objects to be stored 
  11008.                      exceeds the limit set by ADSM. 
  11009.  
  11010.       Valid values   A non-zero numeric value 
  11011.  
  11012.       This keyword is optional.  If it is absent when creating the storage 
  11013.       device, a default value will be used. If it is absent when updating the 
  11014.       storage device, the setting will not be changed. 
  11015.  
  11016.       PASSWORDLIFE 
  11017.  
  11018.       Meaning        If a password is required to access the services of ADSM, 
  11019.                      OS/2 Warp Server Backup/Restore will prompt you to enter 
  11020.                      your password the first time you attempt to use the 
  11021.                      services of ADSM in each use of OS/2 Warp Server 
  11022.                      Backup/Restore. If you use the services of ADSM more than 
  11023.                      once in a single use of OS/2 Warp Server Backup/Restore, 
  11024.                      OS/2 Warp Server Backup/Restore will not ask you to enter 
  11025.                      your password again until the number of minutes specified 
  11026.                      by PASSWORDLIFE has passed. 
  11027.       Valid values   A non-zero numeric value. 
  11028.  
  11029.       This keyword is optional.  If it is absent when creating the storage 
  11030.       device, a default value will be used. If it is absent when updating the 
  11031.       storage device, the setting will not be changed. 
  11032.  
  11033.       PASSWORDPROMPT 
  11034.  
  11035.       Meaning        Whether OS/2 Warp Server Backup/Restore should prompt for 
  11036.                      entry of the ADSM password when connecting to the ADSM 
  11037.                      server during unattended operation. 
  11038.  
  11039.                      Note:  If entry of the ADSM password is required during 
  11040.                      unattended operation and password prompting has been 
  11041.                      suppressed (PASSWORDPROMPT=NO), the operation will fail. 
  11042.                      The requirement for entry of the ADSM password can be 
  11043.                      avoided by using the option 'PASSWORDACCESS GENERATE' in 
  11044.                      the ADSM options file, or by setting the ADSM password by 
  11045.                      use of the PASSWORD keyword in the ADSM storage device 
  11046.                      configuration string. 
  11047.  
  11048.       Valid values   YES or NO 
  11049.  
  11050.       This keyword is optional.  If it is absent when creating the storage 
  11051.       device, prompting for the ADSM password during unattended operation will 
  11052.       not be suppressed. If it is absent when updating the storage device, the 
  11053.       setting will not be changed. 
  11054.  
  11055.       PASSWORD 
  11056.  
  11057.       Meaning        This keyword may be used to set the ADSM password for the 
  11058.                      current execution of the API server; the value will not be 
  11059.                      retained for future invocations of the server. 
  11060.       Valid value    The correct password for the ADSM node name associated 
  11061.                      with the ADSM storage device. 
  11062.  
  11063.       This keyword is optional.  If it is absent, no password will be set. 
  11064.  
  11065.       NEWPASSWORD 
  11066.  
  11067.       Meaning        This keyword may be used to change the ADSM password. 
  11068.  
  11069.                      Note:  The current password must also be specified by the 
  11070.                      PASSWORD keyword, unless the option 'PASSWORDACCESS 
  11071.                      GENERATE' is included in the ADSM options file and the 
  11072.                      current password is stored locally by ADSM (in encrypted 
  11073.                      form). 
  11074.  
  11075.       Valid value    A valid ADSM password. 
  11076.  
  11077.       This keyword is optional.  If it is absent, the password will not be 
  11078.       changed. 
  11079.  
  11080.       CONNECT 
  11081.  
  11082.       Meaning        Whether OS/2 Warp Server Backup/Restore should test the 
  11083.                      connection to the ADSM server. 
  11084.       Valid values   YES or NO 
  11085.  
  11086.       This keyword is optional.  If it is absent, the connection to the ADSM 
  11087.       server will not be tested. 
  11088.  
  11089.  For example: 
  11090.  
  11091.   PsnsSetStorageDeviceConfig handle, "ADSM",
  11092.                              "OPTIONSFILE=C:\\ADSM\\DSM.OPT;NODENAME=PSNSclient"
  11093.  
  11094.  
  11095. ΓòÉΓòÉΓòÉ 19.3.2. Updating the ADSM options file ΓòÉΓòÉΓòÉ
  11096.  
  11097. The ADSM storage device configuration string can contain special keywords (In 
  11098. addition to the standard OS/2 Warp Server Backup/Restore configuration string 
  11099. syntax) in order to add, change or delete options in the ADSM options file. 
  11100.  
  11101. ADSM options may be added or changed by including specifications of the form: 
  11102.  
  11103. +option value
  11104. where: 
  11105.  
  11106.  option    is the name of an ADSM option to be added to, or changed, in the 
  11107.            ADSM options file. 
  11108.  value     is the value to be set for the ADSM option. 
  11109.  
  11110.   Or: 
  11111.  
  11112.   -option
  11113.  where: 
  11114.  
  11115.  option    is the name of an ADSM option to be deleted from the ADSM options 
  11116.            file. 
  11117.  
  11118.  Note:  No validation of the ADSM option name or value is performed. 
  11119.  
  11120.  For example: 
  11121.  
  11122.   PsnsSetStorageDeviceConfig handle, "ADSM",
  11123.                              "OPTIONSFILE=C:\\ADSM\\DSM.OPT;" \
  11124.                              "NEWOPTIONSFILE=C:\\ADSM\\PSNS.OPT;" \
  11125.                              "-verbose; +quiet;" \
  11126.                              "+PASSWORDACCESS GENERATE;-PASSWORDDIR;" \
  11127.                              "+COMMMETHOD TCPIP;" \
  11128.                              "+TCPPort 1500;" \
  11129.                              "+TCPServeraddress n.n.n.n;" \
  11130.                              "+TCPBuffsize 8;" \
  11131.                              "+TCPWindowsize 16"
  11132.  
  11133.  
  11134. ΓòÉΓòÉΓòÉ 19.3.3. Backup set configuration ΓòÉΓòÉΓòÉ
  11135.  
  11136. ADSM backup sets have no configurable settings. 
  11137.  
  11138.  
  11139. ΓòÉΓòÉΓòÉ 19.4. Hard disk and remote disk storage devices ΓòÉΓòÉΓòÉ
  11140.  
  11141. These sections describe configuration strings for hard disk and remote disk 
  11142. storage devices and backup sets. 
  11143.  
  11144.      Storage device configuration 
  11145.  
  11146.      Backup set configuration 
  11147.  
  11148.  
  11149. ΓòÉΓòÉΓòÉ 19.4.1. Storage device configuration ΓòÉΓòÉΓòÉ
  11150.  
  11151.       DRIVE 
  11152.  
  11153.       Meaning        The letter of the drive which the storage device is to use 
  11154.                      for backup. 
  11155.       Valid values   A drive letter. 
  11156.  
  11157.       This keyword must be supplied when creating a storage device. 
  11158.  
  11159.       PATH 
  11160.  
  11161.       Meaning        The name of the directory in which the storage device will 
  11162.                      store backed up data. 
  11163.       Valid values   A valid directory name.  The directory must exist. 
  11164.  
  11165.       This keyword is optional when creating a storage device: if it is absent, 
  11166.       the directory PSNS5BKP will be used. 
  11167.  
  11168.  For example: 
  11169.  
  11170.   PsnsCreateStorageDevice handle, "Hard Disk", "DRIVE=D;PATH=BACKUP"
  11171.  
  11172.  Hard and remote disk storage devices cannot be reconfigured. 
  11173.  
  11174.  
  11175. ΓòÉΓòÉΓòÉ 19.4.2. Backup set configuration ΓòÉΓòÉΓòÉ
  11176.  
  11177. The following keyword is supported: 
  11178.  
  11179.       PATH 
  11180.  
  11181.       Meaning        The directory under the storage device's directory which 
  11182.                      the backup set will use to store data. 
  11183.       Valid values   A valid directory name.  The directory must exist. 
  11184.  
  11185.       This keyword is optional when creating a backup set: if it is absent, a 
  11186.       name will be generated from the name of the backup set. 
  11187.  
  11188.  For example: 
  11189.  
  11190.   PsnsCreateBackupSet handle, "coolName", "Hard Disk", "PATH=LLAMA"
  11191.  
  11192.  Hard and remote disk backup sets cannot be reconfigured. 
  11193.  
  11194.  
  11195. ΓòÉΓòÉΓòÉ 19.5. LAN alias storage devices ΓòÉΓòÉΓòÉ
  11196.  
  11197. These sections describe configuration strings for LAN alias storage devices and 
  11198. backup sets. 
  11199.  
  11200.      Storage device configuration 
  11201.  
  11202.      Backup set configuration 
  11203.  
  11204.  
  11205. ΓòÉΓòÉΓòÉ 19.5.1. Storage device configuration ΓòÉΓòÉΓòÉ
  11206.  
  11207. The following keywords are supported: 
  11208.  
  11209.       SERVER 
  11210.  
  11211.       Meaning        The name of the LAN server on which the device is to store 
  11212.                      data. 
  11213.       Valid values   The name of a LAN server. 
  11214.  
  11215.       This keyword must be supplied when creating a storage device. 
  11216.  
  11217.       ALIAS 
  11218.  
  11219.       Meaning        The name of the alias on the server on which the device is 
  11220.                      to store data. 
  11221.       Valid values   A LAN server alias 
  11222.  
  11223.       This keyword must be supplied when creating a storage device. 
  11224.  
  11225.       PATH 
  11226.  
  11227.       Meaning        The name of the directory in which the storage device will 
  11228.                      store backed up data. 
  11229.       Valid values   A valid directory name.  The directory must exist. 
  11230.  
  11231.       This keyword is optional when creating a storage device: if it is absent, 
  11232.       the directory PSNS5BKP will be used. 
  11233.  
  11234.  For example: 
  11235.  
  11236.   PsnsCreateStorageDevice handle, "Lan Alias", "SERVER=WDGSRV;ALIAS=PSNS"
  11237.  
  11238.  LAN alias storage devices cannot be reconfigured. 
  11239.  
  11240.  
  11241. ΓòÉΓòÉΓòÉ 19.5.2. Backup set configuration ΓòÉΓòÉΓòÉ
  11242.  
  11243. The following keyword is supported: 
  11244.  
  11245.       PATH 
  11246.  
  11247.       Meaning        The directory under the storage device's directory which 
  11248.                      the backup set will use to store data. 
  11249.       Valid values   A valid directory name.  The directory must exist. 
  11250.  
  11251.       This keyword is optional when creating a backup set: if it is absent, a 
  11252.       name will be generated from the name of the backup set. 
  11253.  
  11254.  For example: 
  11255.  
  11256.   PsnsCreateBackupSet handle, "coolName", "Diskette", "PATH=LLAMA"
  11257.  
  11258.  LAN alias backup sets cannot be reconfigured. 
  11259.  
  11260.  
  11261. ΓòÉΓòÉΓòÉ 19.6. Removable drive storage device ΓòÉΓòÉΓòÉ
  11262.  
  11263. These sections describe configuration strings for the removable drive storage 
  11264. device and backup sets. 
  11265.  
  11266.  
  11267. ΓòÉΓòÉΓòÉ 19.6.1. Storage device configuration ΓòÉΓòÉΓòÉ
  11268.  
  11269.       DRIVE 
  11270.  
  11271.       Meaning        The letter of the drive which the storage device is to use 
  11272.                      for backup. 
  11273.       Valid values   A drive letter. 
  11274.  
  11275.       This keyword must be supplied when creating a storage device. 
  11276.  
  11277.       PATH 
  11278.  
  11279.       Meaning        The name of the directory in which the storage device will 
  11280.                      store backed up data. 
  11281.       Valid values   A valid directory name.  The directory must exist. 
  11282.  
  11283.       This keyword is optional when creating a storage device.  If it is 
  11284.       absent, the directory PSNS6BKP will be used. 
  11285.  
  11286.  For example: 
  11287.  
  11288.   PsnsCreateStorageDevice handle, "Removable Drive", "DRIVE=D;PATH=BACKUP"
  11289.  
  11290.  Removable Drive storage devices cannot be reconfigured. 
  11291.  
  11292.  
  11293. ΓòÉΓòÉΓòÉ 19.6.2. Backup set configuration ΓòÉΓòÉΓòÉ
  11294.  
  11295. The following keywords are supported: 
  11296.  
  11297.       BACKUPINDEX 
  11298.  
  11299.       Meaning        If you select this option, OS/2 Warp Server Backup/Restore 
  11300.                      will automatically back up its Index Files for the Backup 
  11301.                      Set every time you perform a backup. 
  11302.  
  11303.                      Warning: If the Back up index files option is not selected 
  11304.                      then no back ups are made of the Index Files. This is 
  11305.                      strongly discouraged, as it means your data will be 
  11306.                      impossible to retrieve if the Index Files on Hard Disk are 
  11307.                      lost. 
  11308.       Valid values   YES or NO 
  11309.  
  11310.       This keyword is optional when creating a backup set.  If it is absent, 
  11311.       index files will be backed up. 
  11312.  
  11313.       BEEP 
  11314.  
  11315.       Meaning        Whether OS/2 Warp Server Backup/Restore should make a 
  11316.                      noise when it asks for a removable drive to be inserted. 
  11317.       Valid values   YES or NO 
  11318.  
  11319.       This keyword is optional when creating a backup set.  If it is absent, a 
  11320.       noise will be made. 
  11321.  
  11322.       VERIFY 
  11323.  
  11324.       Meaning        Whether OS/2 Warp Server Backup/Restore should confirm 
  11325.                      that the data written to the removable drive is correct. 
  11326.       Valid values   YES or NO 
  11327.  
  11328.       This keyword is optional when creating a backup set.  If it is absent, 
  11329.       backups will not be verified. 
  11330.  
  11331.  For example: 
  11332.  
  11333.   PsnsSetBackupSetConfig handle, bksName, "BEEP=NO;VERIFY=YES"
  11334.  
  11335.  Removable drive backup sets can be reconfigured. 
  11336.  
  11337.  
  11338. ΓòÉΓòÉΓòÉ 19.7. Virtual storage device ΓòÉΓòÉΓòÉ
  11339.  
  11340. There are no configuration strings for the virtual storage device or backup 
  11341. sets.