home *** CD-ROM | disk | FTP | other *** search
/ Network Support Encyclopedia 96-1 / novell-nsepro-1996-1-cd2.iso / download / netware / usms1.exe / SMSTSAPI.H < prev    next >
Text File  |  1994-11-14  |  11KB  |  355 lines
  1. /*    
  2. ****************************************************************************
  3. *
  4. * Program Name:   Storage Management Services (TSAPI)
  5. *
  6. * Filename:       smstsapi.h
  7. *
  8. * Date Created:   March 2, 1992
  9. *
  10. * Version:        3.2
  11. *
  12. * Date Modified: 
  13. *
  14. * Modifications:
  15. *
  16. * Comments:       This file contains function prototypes for parameter 
  17. *                 checking and function macros for pointer acquisition.
  18. *                 The macros require that the typedefs and SMSPCODE 
  19. *                 defines be spelled exactly the same after the initial 
  20. *                 SMSP_.
  21. *
  22. * (C) Unpublished Copyright of Novell, Inc.  All Rights Reserved.
  23. *
  24. * No part of this file may be duplicated, revised, translated, localized or
  25. * modified in any manner or compiled, linked or uploaded or downloaded to or
  26. * from any computer system without the prior written consent of Novell, Inc.
  27. *
  28. ****************************************************************************
  29. */
  30.  
  31. #ifndef _SMSTSAPI_H_INCLUDED      /* smstsapi.h header latch */
  32. #define _SMSTSAPI_H_INCLUDED
  33.  
  34. #include <smstypes.h>
  35. #include <smstserr.h>
  36.  
  37. /***************************************************************************/
  38. typedef 
  39. CCODE _NWSMTSConnectToTargetService(
  40.             UINT32                     *connectionID, 
  41.             STRING                      targetServiceName,
  42.             STRING                      targetUserName, 
  43.             void                     *authentication);
  44. typedef
  45. CCODE _NWSMTSAuthenticateTS(
  46.             UINT32                  *connectionHandle,
  47.            STRING                   targetServiceName,
  48.            UINT32                     authType,
  49.            NWSM_LongByteStream     *authData);
  50.  
  51. typedef 
  52. CCODE _NWSMTSReleaseTargetService(
  53.             UINT32                     *connectionID);
  54.  
  55. typedef
  56. CCODE _NWSMTSReturnToParent(
  57.             UINT32                      connectionID, 
  58.             UINT32                     *sequence);
  59.  
  60. typedef
  61. CCODE _NWSMTSScanTargetServiceName(
  62.             UINT32                      connectionID, 
  63.             UINT32                     *sequence,
  64.             STRING                      pattern, 
  65.             STRING                      name);
  66.  
  67. typedef
  68. CCODE _NWSMTSBeginRestoreSession(
  69.             UINT32                      connectionID);
  70.  
  71. typedef
  72. CCODE _NWSMTSGetTargetServiceType(
  73.             UINT32                      connectionID, 
  74.             STRING                      name,
  75.             STRING                      type, 
  76.             STRING                      version);
  77.  
  78. typedef
  79. CCODE _NWSMTSGetTargetServiceAddress(
  80.             UINT32                      connectionID,
  81.             STRING                      targetServiceName,
  82.             UINT32                      *addressType,
  83.             STRING                      address);
  84.  
  85. typedef
  86. CCODE _NWSMTSGetTargetResourceInfo(
  87.             UINT32                      connectionID, 
  88.             STRING                      resource,
  89.             UINT16                     *blocksize, 
  90.             UINT32                     *totalblocks, 
  91.             UINT32                     *freeblocks,
  92.             NWBOOLEAN                 *isRemoveable, 
  93.             UINT32                     *purgableblocks, 
  94.             UINT32                     *unpurgedblocks,
  95.             UINT32                     *migratedSectors,
  96.             UINT32                     *preCompressedSectors,
  97.             UINT32                     *compressedSectors);
  98.  
  99. typedef
  100. CCODE _NWSMTSGetUnsupportedOptions(
  101.             UINT32                      connectionID, 
  102.             UINT32                     *unsupportedBackupOptions,
  103.             UINT32                     *unsupportedRestoreOptions);
  104.  
  105. typedef
  106. CCODE _NWSMTSScanTSResource(
  107.             UINT32                      connectionID, 
  108.             UINT32                     *sequence,
  109.             STRING                      resource);
  110.  
  111. typedef
  112. CCODE _NWSMTSListTSResources(
  113.             UINT32                        connectionID, 
  114.             NWSM_NAME_LIST                **serviceResourceList);
  115.             
  116. typedef
  117. CCODE _NWSMTSScanDataSetBegin(
  118.             UINT32                      connectionID,
  119.             NWSM_DATA_SET_NAME_LIST     *resourceName,
  120.             NWSM_SCAN_CONTROL         *scanControl, 
  121.             NWSM_SELECTION_LIST         *selectionList,
  122.             UINT32                     *sequence, 
  123.             NWSM_SCAN_INFORMATION    **scanInformation, 
  124.             NWSM_DATA_SET_NAME_LIST    **dataSetNames);
  125.  
  126. typedef
  127. CCODE _NWSMTSScanNextDataSet(
  128.             UINT32                      connectionID, 
  129.             UINT32                     *sequence, 
  130.             NWSM_SCAN_INFORMATION    **scanInformation,
  131.             NWSM_DATA_SET_NAME_LIST    **dataSetNames);
  132.  
  133. typedef
  134. CCODE _NWSMTSScanDataSetEnd(
  135.             UINT32                      connectionID, 
  136.             UINT32                     *sequence, 
  137.             NWSM_SCAN_INFORMATION    **scanInformation,
  138.             NWSM_DATA_SET_NAME_LIST    **dataSetNames);
  139.  
  140. typedef
  141. CCODE _NWSMTSRenameDataSet(
  142.             UINT32                      connectionID, 
  143.             UINT32                      sequence, 
  144.             UINT32                      nameSpaceType, 
  145.             LSTRING                      newDataSetName);
  146.  
  147. typedef
  148. CCODE _NWSMTSDeleteDataSet(
  149.             UINT32                      connectionID, 
  150.             UINT32                      sequence);
  151.  
  152. typedef
  153. CCODE _NWSMTSSetArchiveStatus(
  154.             UINT32                    connectionID, 
  155.             UINT32                    handle, 
  156.             UINT32                    setFlag, 
  157.             UINT32                    archivedDateAndTime);
  158.  
  159. typedef
  160. CCODE _NWSMTSOpenDataSetForRestore(
  161.             UINT32                      connectionID, 
  162.             UINT32                      parentHandle, 
  163.             NWSM_DATA_SET_NAME_LIST     *dataSetName, 
  164.             UINT32                      mode, 
  165.             UINT32                     *handle);
  166.  
  167. typedef
  168. CCODE _NWSMTSOpenDataSetForBackup(
  169.             UINT32                      connectionID, 
  170.             UINT32                    sequence, 
  171.             UINT32                    mode, 
  172.             UINT32                      *handle);
  173.  
  174. typedef
  175. CCODE _NWSMTSCloseDataSet(
  176.             UINT32                      connectionID, 
  177.             UINT32                     *handle);
  178.  
  179. typedef
  180. CCODE _NWSMTSReadDataSet(
  181.             UINT32                      connectionID, 
  182.             UINT32                      handle, 
  183.             UINT32                      bytesToRead, 
  184.             UINT32                     *bytesRead, 
  185.             BUFFERPTR                  buffer);
  186.  
  187. typedef
  188. CCODE _NWSMTSWriteDataSet(
  189.             UINT32                      connectionID, 
  190.             UINT32                      handle, 
  191.             UINT32                      bytesToWrite, 
  192.             BUFFERPTR                  buffer);
  193.     
  194. typedef
  195. CCODE _NWSMTSIsDataSetExcluded(
  196.             UINT32                      connectionID, 
  197.             NWBOOLEAN                  isParent,
  198.             NWSM_DATA_SET_NAME_LIST     *namelist);
  199.  
  200. typedef
  201. CCODE _NWSMTSBuildResourceList(
  202.             UINT32                      connectionID);
  203.  
  204. typedef
  205. CCODE _NWSMTSSetRestoreOptions(
  206.             UINT32                      connectionID, 
  207.             NWBOOLEAN                  checkCRC, 
  208.             NWBOOLEAN                  dontCheckSelectionList, 
  209.             NWSM_SELECTION_LIST         *selectionList);
  210.  
  211. typedef
  212. CCODE _NWSMTSParseDataSetName(
  213.             UINT32                    connectionID, 
  214.             UINT32                    nameSpaceType,
  215.             STRING                    dataSetName, 
  216.             UINT16                     *count, 
  217.             UINT16_BUFFER             **namePositions,
  218.             UINT16_BUFFER             **separatorPositions);
  219.  
  220. typedef
  221. CCODE _NWSMTSCatDataSetName(
  222.             UINT32                       connectionID, 
  223.             UINT32                       nameSpaceType,
  224.             STRING                       dataSetName, 
  225.             STRING                       terminalName, 
  226.             NWBOOLEAN                  terminalIsParent,
  227.             STRING_BUFFER            **newDataSetName);
  228.  
  229. typedef
  230. CCODE _NWSMTSSeparateDataSetName(
  231.             UINT32                      connectionID, 
  232.             UINT32                      nameSpaceType,
  233.             STRING                      dataSetName, 
  234.             STRING_BUFFER             **parentDataSetName,
  235.             STRING_BUFFER             **childDataSetName);
  236.  
  237. typedef
  238. CCODE _NWSMTSFixDataSetName(
  239.             UINT32                      connectionID, 
  240.             STRING                      dataSetName,
  241.            UINT32                       nameSpaceType,
  242.             NWBOOLEAN                  isParent,
  243.             NWBOOLEAN                  wildAllowedOnTerminal,
  244.             STRING_BUFFER            **newDataSetName);
  245.  
  246. typedef
  247. CCODE _NWSMTSGetNameSpaceTypeInfo(
  248.             UINT32                       connectionID,
  249.             UINT32                       nameSpaceType, 
  250.             NWBOOLEAN                 *reverseOrder, 
  251.             STRING_BUFFER             **sep1, 
  252.             STRING_BUFFER             **sep2);
  253.  
  254. typedef
  255. CCODE _NWSMTSScanSupportedNameSpaces(
  256.             UINT32                       connectionID, 
  257.             UINT32                     *sequence,
  258.             STRING                       resourceName, 
  259.             UINT32                     *nameSpaceType, 
  260.             STRING                       nameSpaceName);
  261.  
  262. typedef
  263. CCODE  _NWSMTSListSupportedNameSpaces(
  264.             UINT32                        connectionID, 
  265.             STRING                        resourceName,
  266.             NWSM_NAME_LIST                 **nameSpaceList);
  267.         
  268. typedef
  269. CCODE _NWSMTSGetTargetSelTypeStr(
  270.             UINT32                      connectionID, 
  271.             UINT8                      typeNumber, 
  272.             STRING                      selectionTypeString1, 
  273.             STRING                      selectionTypeString2);
  274.  
  275. typedef
  276. CCODE _NWSMTSGetTargetScanTypeString(
  277.             UINT32                      connectionID,
  278.             UINT8                      typeNumber, 
  279.             STRING                      scanTypeString, 
  280.             UINT32                     *required,
  281.             UINT32                     *disallowed);
  282.  
  283. typedef
  284. CCODE _NWSMTSGetOpenModeOptionString(
  285.             UINT32                      connectionID, 
  286.             UINT8                      optionNumber, 
  287.             STRING                      optionString);
  288.  
  289. typedef
  290. CCODE _NWSMTSConvertError(
  291.             UINT32                      connectionID, 
  292.             CCODE                      error, 
  293.             STRING                      message);
  294.  
  295. typedef 
  296. CCODE _NWSMGetVersionInfo(
  297.             UINT32                      connectionID,
  298.             NWSM_MODULE_VERSION_INFO *info);
  299.  
  300. /***************************************************************************/
  301.  
  302. CCODE NWSMConnectToTSA(
  303.         char                         *TSA, 
  304.         UINT32                         *connectionID);
  305.  
  306. CCODE NWSMReleaseTSA(
  307.         UINT32                         *connectionID);
  308.  
  309. _NWSMTSConnectToTargetService    NWSMTSConnectToTargetService;
  310. _NWSMTSAuthenticateTS            NWSMTSAuthenticateTS;
  311. _NWSMTSReleaseTargetService      NWSMTSReleaseTargetService;
  312. _NWSMTSReturnToParent            NWSMTSReturnToParent;
  313. _NWSMTSScanTargetServiceName     NWSMTSScanTargetServiceName;
  314. _NWSMTSBeginRestoreSession       NWSMTSBeginRestoreSession;
  315. _NWSMTSGetTargetServiceType      NWSMTSGetTargetServiceType;
  316. _NWSMTSGetTargetServiceAddress   NWSMTSGetTargetServiceAddress;
  317. _NWSMTSGetTargetResourceInfo     NWSMTSGetTargetResourceInfo;
  318. _NWSMTSScanTSResource            NWSMTSScanTargetServiceResource;
  319. _NWSMTSScanDataSetBegin          NWSMTSScanDataSetBegin;
  320. _NWSMTSScanNextDataSet           NWSMTSScanNextDataSet;
  321. _NWSMTSScanDataSetEnd            NWSMTSScanDataSetEnd;
  322. _NWSMTSRenameDataSet             NWSMTSRenameDataSet;
  323. _NWSMTSDeleteDataSet             NWSMTSDeleteDataSet;
  324. _NWSMTSSetArchiveStatus          NWSMTSSetArchiveStatus;
  325. _NWSMTSOpenDataSetForRestore     NWSMTSOpenDataSetForRestore;
  326. _NWSMTSOpenDataSetForBackup      NWSMTSOpenDataSetForBackup;
  327. _NWSMTSCloseDataSet              NWSMTSCloseDataSet;
  328. _NWSMTSReadDataSet               NWSMTSReadDataSet;
  329. _NWSMTSWriteDataSet              NWSMTSWriteDataSet;
  330. _NWSMTSIsDataSetExcluded         NWSMTSIsDataSetExcluded;
  331. _NWSMTSBuildResourceList         NWSMTSBuildResourceList;
  332. _NWSMTSSetRestoreOptions         NWSMTSSetRestoreOptions;
  333. _NWSMTSParseDataSetName          NWSMTSParseDataSetName;
  334. _NWSMTSCatDataSetName            NWSMTSCatDataSetName;
  335. _NWSMTSSeparateDataSetName       NWSMTSSeparateDataSetName;
  336. _NWSMTSFixDataSetName            NWSMTSFixDataSetName;
  337. _NWSMTSGetNameSpaceTypeInfo      NWSMTSGetNameSpaceTypeInfo;
  338. _NWSMTSScanSupportedNameSpaces   NWSMTSScanSupportedNameSpaces;
  339. _NWSMTSGetTargetSelTypeStr       NWSMTSGetTargetSelectionTypeStr;
  340. _NWSMTSGetTargetScanTypeString   NWSMTSGetTargetScanTypeString;
  341. _NWSMTSGetOpenModeOptionString   NWSMTSGetOpenModeOptionString;
  342. _NWSMTSConvertError              NWSMTSConvertError;
  343. _NWSMTSListSupportedNameSpaces   NWSMTSListSupportedNameSpaces;
  344. _NWSMTSListTSResources           NWSMTSListTSResources;
  345. _NWSMTSGetUnsupportedOptions     NWSMTSGetUnsupportedOptions;
  346. _NWSMGetVersionInfo              NWSMGetRequestorVersionInfo,
  347.                                  NWSMGetResponderVersionInfo,
  348.                                  NWSMGetSMSModuleVersionInfo;
  349.  
  350. void DestroyConnectionList(void);
  351.  
  352. #endif                            /* smstsapi.h header latch */
  353. /***************************************************************************/
  354.  
  355.