开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 多媒体编程 > 查看源码
NetworkSetup.h
资源名称：fullMPCcode.rar　[点击查看]
上传用户：xjjlds
上传日期：2015-12-05
资源大小：22823k
文件大小：66k
源码类别：

多媒体编程

开发平台：

Visual C++

NetworkSetup.h：源码内容
  1. /*
  2.      File:       NetworkSetup.h
  3.  
  4.      Contains:   Network Setup Interfaces
  5.  
  6.      Version:    Technology: 1.1.0
  7.                  Release:    QuickTime 6.0.2
  8.  
  9.      Copyright:  (c) 1998-2001 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:      For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __NETWORKSETUP__
  18. #define __NETWORKSETUP__
  20. #ifndef __MACTYPES__
  21. #include "MacTypes.h"
  22. #endif
  24. #ifndef __FILES__
  25. #include "Files.h"
  26. #endif
  28. #ifndef __OPENTRANSPORT__
  29. #include "OpenTransport.h"
  30. #endif
  32. #ifndef __OPENTRANSPORTPROVIDERS__
  33. #include "OpenTransportProviders.h"
  34. #endif
  39. #if PRAGMA_ONCE
  40. #pragma once
  41. #endif
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  47. #if PRAGMA_IMPORT
  48. #pragma import on
  49. #endif
  51. #if PRAGMA_STRUCT_ALIGN
  52.     #pragma options align=mac68k
  53. #elif PRAGMA_STRUCT_PACKPUSH
  54.     #pragma pack(push, 2)
  55. #elif PRAGMA_STRUCT_PACK
  56.     #pragma pack(2)
  57. #endif
  59. #if CALL_NOT_IN_CARBON
  60. #ifndef __NETWORKSETUPTYPES__
  61. #define __NETWORKSETUPTYPES__
  62. typedef struct OpaqueCfgDatabaseRef*    CfgDatabaseRef;
  63. typedef UInt32                          CfgAreaID;
  64. typedef OSType                          CfgEntityClass;
  65. typedef OSType                          CfgEntityType;
  67. struct CfgEntityRef {
  68.     CfgAreaID                       fLoc;
  69.     UInt32                          fReserved;
  70.     Str255                          fID;
  71. };
  72. typedef struct CfgEntityRef             CfgEntityRef;
  74. struct CfgResourceLocator {
  75.     FSSpec                          fFile;
  76.     UInt16                          fResID;
  77. };
  78. typedef struct CfgResourceLocator       CfgResourceLocator;
  80. struct CfgEntityInfo {
  81.     CfgEntityClass                  fClass;
  82.     CfgEntityType                   fType;
  83.     Str255                          fName;
  84.     CfgResourceLocator              fIcon;
  85. };
  86. typedef struct CfgEntityInfo            CfgEntityInfo;
  88. typedef void *                          CfgEntityAccessID;
  90. struct CfgPrefsHeader {
  91.     UInt16                          fSize;                      /* size includes this header*/
  92.     UInt16                          fVersion;
  93.     OSType                          fType;
  94. };
  95. typedef struct CfgPrefsHeader           CfgPrefsHeader;
  96. /*    -------------------------------------------------------------------------
  97.     Error codes
  98.     ------------------------------------------------------------------------- */
  99. enum {
  100.     kCfgErrDatabaseChanged      = -3290,                        /* database has changed since last call - close and reopen DB*/
  101.     kCfgErrAreaNotFound         = -3291,                        /* Area doesn't exist*/
  102.     kCfgErrAreaAlreadyExists    = -3292,                        /* Area already exists*/
  103.     kCfgErrAreaNotOpen          = -3293,                        /* Area needs to open first*/
  104.     kCfgErrConfigLocked         = -3294,                        /* Access conflict - retry later*/
  105.     kCfgErrEntityNotFound       = -3295,                        /* An entity with this name doesn't exist*/
  106.     kCfgErrEntityAlreadyExists  = -3296,                        /* An entity with this name already exists*/
  107.     kCfgErrPrefsTypeNotFound    = -3297,                        /* An record with this PrefsType doesn't exist*/
  108.     kCfgErrDataTruncated        = -3298,                        /* Data truncated when read buffer too small*/
  109.     kCfgErrFileCorrupted        = -3299                         /* The database format appears to be corrupted.*/
  110. };
  112. /*  reserve a 'free' tag for free blocks*/
  113. enum {
  114.     kCfgTypefree                = FOUR_CHAR_CODE('free')
  115. };
  117. /*    -------------------------------------------------------------------------
  118.     CfgEntityClass / CfgEntityType
  120.     The database can distinguish between several classes of objects and 
  121.     several types withing each class
  122.     Use of different classes allow to store type of information in the same database
  124.     Other entity classes and types can be defined by developers.
  125.     they should be unique and registered with Developer Tech Support (DTS)
  126.     ------------------------------------------------------------------------- */
  127. enum {
  128.     kCfgClassAnyEntity          = FOUR_CHAR_CODE('****'),
  129.     kCfgClassUnknownEntity      = FOUR_CHAR_CODE('????'),
  130.     kCfgTypeAnyEntity           = FOUR_CHAR_CODE('****'),
  131.     kCfgTypeUnknownEntity       = FOUR_CHAR_CODE('????')
  132. };
  134. /*    -------------------------------------------------------------------------
  135.     For CfgIsSameEntityRef
  136.     ------------------------------------------------------------------------- */
  137. enum {
  138.     kCfgIgnoreArea              = true,
  139.     kCfgDontIgnoreArea          = false
  140. };
  142. #endif  /* __NETWORKSETUPTYPES__ */
  143. /*******************************************************************************
  144. **  Configuration Information Access API 
  145. ********************************************************************************/
  146. /*    -------------------------------------------------------------------------
  147.     Database access
  148.     ------------------------------------------------------------------------- */
  149. #if CALL_NOT_IN_CARBON
  150. EXTERN_API( OSStatus )
  151. OTCfgOpenDatabase               (CfgDatabaseRef *       dbRef);
  153. /*
  154.     OTCfgOpenDatabase()
  156.     Inputs:     none
  157.     Outputs:    CfgDatabaseRef* dbRef           Reference to opened database
  158.     Returns:    OSStatus                        *** list errors ***
  160.     Opens the Configuration API for a given client. This call should be made prior to any other call.
  161. */
  162. EXTERN_API( OSStatus )
  163. OTCfgCloseDatabase              (CfgDatabaseRef *       dbRef);
  165. /*
  166.     OTCfgCloseDatabase()
  168.     Inputs:     CfgDatabaseRef* dbRef           Reference to opened database
  169.     Outputs:    CfgDatabaseRef* dbRef           Reference to opened database is cleared
  170.     Returns:    OSStatus                        *** list errors ***
  172.     Closes the Configuration API for a given client. This call should be made when the client no 
  173.     longer wants to use the Configuration API.  
  174. */
  175. /*    -------------------------------------------------------------------------
  176.     Area management
  177.     ------------------------------------------------------------------------- */
  178. EXTERN_API( OSStatus )
  179. OTCfgGetAreasCount              (CfgDatabaseRef         dbRef,
  180.                                  ItemCount *            itemCount);
  182. /*
  183.     OTCfgGetAreasCount()
  185.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  186.     Outputs:    ItemCount* itemCount            Number of entities defined
  187.     Returns:    OSStatus                        *** list errors ***
  189.     Returns the number of areas currently defined.
  190. */
  191. EXTERN_API( OSStatus )
  192. OTCfgGetAreasList               (CfgDatabaseRef         dbRef,
  193.                                  ItemCount *            itemCount,
  194.                                  CfgAreaID              areaID[],
  195.                                  Str255                 areaName[]);
  197. /*
  198.     OTCfgGetAreasList()
  200.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  201.                 ItemCount* itemCount            Number of entities requested
  202.     Outputs:    ItemCount* itemCount            Number of entities defined
  203.     Returns:    OSStatus                        *** list errors ***
  205.     Returns a list of area IDs and names. On entry, count should be set to whatever OTCfgGetAreasCount 
  206.     returned.  On exit, count contains the actual number of areas found. This can be less than the 
  207.     initial count value if areas were deleted in the meantime.  The id and name parameters are stored 
  208.     in arrays that should each be able to contain count values.
  209. */
  210. EXTERN_API( OSStatus )
  211. OTCfgGetCurrentArea             (CfgDatabaseRef         dbRef,
  212.                                  CfgAreaID *            areaID);
  214. /*
  215.     OTCfgGetCurrentArea()
  217.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  218.     Outputs:    CfgAreaID* areaID               ID of current area
  219.     Returns:    OSStatus                        *** list errors ***
  221.     Returns the id of the current area.
  222. */
  223. EXTERN_API( OSStatus )
  224. OTCfgSetCurrentArea             (CfgDatabaseRef         dbRef,
  225.                                  CfgAreaID              areaID);
  227. /*
  228.     OTCfgSetCurrentArea()
  230.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  231.                 CfgAreaID areaID                ID of area to make active
  232.     Outputs:    none
  233.     Returns:    OSStatus                        *** list errors ***
  235.     Sets the current area. If the area doesn't exist kCfgErrAreaNotFound is returned.
  236. */
  237. EXTERN_API( OSStatus )
  238. OTCfgCreateArea                 (CfgDatabaseRef         dbRef,
  239.                                  ConstStr255Param       areaName,
  240.                                  CfgAreaID *            areaID);
  242. /*
  243.     OTCfgCreateArea()
  245.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  246.                 ConstStr255Param areaName       Name of area to create
  247.     Outputs:    CfgAreaID* areaID               ID of newly created area
  248.     Returns:    OSStatus                        *** list errors ***
  250.     Creates a new area with the specified name. Then name must be unique or kCfgErrAreaAlreadyExists 
  251.     will be returned.
  252. */
  253. EXTERN_API( OSStatus )
  254. OTCfgDeleteArea                 (CfgDatabaseRef         dbRef,
  255.                                  CfgAreaID              areaID);
  257. /*
  258.     OTCfgDeleteArea()
  260.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  261.                 CfgAreaID areaID                ID of area to delete
  262.     Outputs:    none
  263.     Returns:    OSStatus                        *** list errors ***
  265.     Deletes the specified area. If the area doesn't exist kCfgErrAreaNotFound is returned.
  266. */
  267. EXTERN_API( OSStatus )
  268. OTCfgDuplicateArea              (CfgDatabaseRef         dbRef,
  269.                                  CfgAreaID              sourceAreaID,
  270.                                  CfgAreaID              destAreaID);
  272. /*
  273.     OTCfgDuplicateArea()
  275.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  276.                 CfgAreaID sourceAreaID          Area to duplicate
  277.                 CfgAreaID destAreaID            Area to contain duplicate
  278.     Outputs:    none
  279.     Returns:    OSStatus                        *** list errors ***
  281.     Duplicates the source area content into the destination area. Both areas should exist prior to 
  282.     making this call. If either area doesn't exist kCfgErrAreaNotFound is returned.
  283. */
  284. EXTERN_API( OSStatus )
  285. OTCfgSetAreaName                (CfgDatabaseRef         dbRef,
  286.                                  CfgAreaID              areaID,
  287.                                  ConstStr255Param       areaName,
  288.                                  CfgAreaID *            newAreaID);
  290. /*
  291.     OTCfgSetAreaName()
  293.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  294.                 CfgAreaID areaID                ID of area being named
  295.                 ConstStr255Param areaName       New name for area
  296.     Outputs:    CfgAreaID* newAreaID            ID of renamed area
  297.     Returns:    OSStatus                        *** list errors ***
  299.     Renames the specified area. A new id is returned: it should be used from now on. If the area 
  300.     doesn't exist kCfgErrAreaNotFound is returned.
  301. */
  302. EXTERN_API( OSStatus )
  303. OTCfgGetAreaName                (CfgDatabaseRef         dbRef,
  304.                                  CfgAreaID              areaID,
  305.                                  Str255                 areaName);
  307. /*
  308.     OTCfgGetAreaName()
  310.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  311.                 CfgAreaID areaID                ID of area being queried
  312.     Outputs:    Str255 areaName                 Name of area
  313.     Returns:    OSStatus                        *** list errors ***
  315.     Gets the name of the specified area. If the area doesn't exist kCfgErrAreaNotFound is returned.
  316. */
  317. /*    -------------------------------------------------------------------------
  318.     Configuration Database API
  319.     
  320.     Single Writer ONLY!!!
  321.     ------------------------------------------------------------------------- */
  322. /*    -------------------------------------------------------------------------
  323.     Opening an area for reading
  324.     ------------------------------------------------------------------------- */
  325. EXTERN_API( OSStatus )
  326. OTCfgOpenArea                   (CfgDatabaseRef         dbRef,
  327.                                  CfgAreaID              areaID);
  329. /*
  330.     OTCfgOpenArea()
  332.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  333.                 CfgAreaID areaID                ID of area to open
  334.     Outputs:    none
  335.     Returns:    OSStatus                        *** list errors ***
  337.     Opens the specified area for reading. If the area doesn't exist kCfgErrAreaNotFound is returned.
  338. */
  339. EXTERN_API( OSStatus )
  340. OTCfgCloseArea                  (CfgDatabaseRef         dbRef,
  341.                                  CfgAreaID              areaID);
  343. /*
  344.     OTCfgCloseArea()
  346.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  347.                 CfgAreaID areaID                ID of area to close
  348.     Outputs:    none
  349.     Returns:    OSStatus                        *** list errors ***
  351.     Closes an area opened for reading. If the area doesn't exist kCfgErrAreaNotFound is returned.  
  352.     Opening an area for writing All modifications to an area should be performed as part of a 
  353.     transaction.
  354. */
  355. /*
  356.     For write access
  357. */
  358. EXTERN_API( OSStatus )
  359. OTCfgBeginAreaModifications     (CfgDatabaseRef         dbRef,
  360.                                  CfgAreaID              readAreaID,
  361.                                  CfgAreaID *            writeAreaID);
  363. /*
  364.     OTCfgBeginAreaModifications()
  366.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  367.                 CfgAreaID readAreaID            ID of area opened for reading
  368.     Outputs:    CfgAreaID* writeAreaID          ID of area opened for modification
  369.     Returns:    OSStatus                        *** list errors ***
  371.     Opens the specified area for writing. A new area id is provided.  This area id should be used to 
  372.     enumerate, add, delete, read and write to the modified data. The original id can still be used to 
  373.     access the original unmodified data. If the area doesn't exist kCfgErrAreaNotFound is returned.
  374. */
  375. EXTERN_API( OSStatus )
  376. OTCfgCommitAreaModifications    (CfgDatabaseRef         dbRef,
  377.                                  CfgAreaID              readAreaID,
  378.                                  CfgAreaID              writeAreaID);
  380. /*
  381.     OTCfgCommitAreaModifications()
  383.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  384.                 CfgAreaID readAreaID            ID of area opened for reading
  385.                 CfgAreaID writeAreaID           ID of area opened for modification
  386.     Outputs:    none
  387.     Returns:    OSStatus                        *** list errors ***
  389.     Closes an area opened for writing.  All modifications are committed and readers are informed that 
  390.     the database changed state ( kCfgStateChangedErr ). The areaID should be the id of the original 
  391.     area.  If the area doesn't exist or the wrong id is passed, kCfgErrAreaNotFound is returned.
  392. */
  393. EXTERN_API( OSStatus )
  394. OTCfgAbortAreaModifications     (CfgDatabaseRef         dbRef,
  395.                                  CfgAreaID              readAreaID);
  397. /*
  398.     OTCfgAbortAreaModifications()
  400.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  401.                 CfgAreaID readAreaID            ID of area opened for reading
  402.     Outputs:    none
  403.     Returns:    OSStatus                        *** list errors ***
  405.     Closes an area opened for writing, discarding any modification. The areaID should be the id of 
  406.     the original area. If the area doesn't exist or the wrong id is passed kCfgErrAreaNotFound is 
  407.     returned.
  408. */
  409. /*
  410.     Working with entities
  412.     Entities can be manipulated as soon as an area has been opened.  The same calls work both for 
  413.     areas opened for reading or for modification. In the latter case, the calls can be used on the 
  414.     original or new area id to access the original data or the modified data.
  415. */
  416. /*
  417.     For everybody
  418.     Count receives the actual number of entities
  419. */
  420. EXTERN_API( OSStatus )
  421. OTCfgGetEntitiesCount           (CfgDatabaseRef         dbRef,
  422.                                  CfgAreaID              areaID,
  423.                                  CfgEntityClass         entityClass,
  424.                                  CfgEntityType          entityType,
  425.                                  ItemCount *            itemCount);
  427. /*
  428.     OTCfgGetEntitiesCount()
  430.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  431.                 CfgAreaID areaID                ID of area to count
  432.                 CfgEntityClass entityClass      Class of entities to count
  433.                 CfgEntityType entityType        Type of entities to count
  434.     Outputs:    ItemCount* itemCount            Count of matching entities
  435.     Returns:    OSStatus                        *** list errors ***
  437.     Returns the number of entities of the specified class and type in the specified area. To obtain 
  438.     all entities regardless of their class or type pass kCfgClassAnyEntity or kCfgTypeAnyEntity. If 
  439.     the area doesn't exist or the wrong id is passed kCfgErrAreaNotFound is returned.
  440. */
  442. /*
  443.     Count as input, is the number of entities to read;
  444.     count as output, receives the actual number of entities or the number you specified. 
  445. */
  446. EXTERN_API( OSStatus )
  447. OTCfgGetEntitiesList            (CfgDatabaseRef         dbRef,
  448.                                  CfgAreaID              areaID,
  449.                                  CfgEntityClass         entityClass,
  450.                                  CfgEntityType          entityType,
  451.                                  ItemCount *            itemCount,
  452.                                  CfgEntityRef           entityRef[],
  453.                                  CfgEntityInfo          entityInfo[]);
  455. /*
  456.     OTCfgGetEntitiesList()
  458.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  459.                 CfgAreaID areaID                ID of area to list
  460.                 CfgEntityClass entityClass      Class of entities to list
  461.                 CfgEntityType entityType        Type of entities to list
  462.                 ItemCount* itemCount            Count of entities requested
  463.     Outputs:    ItemCount* itemCount            Count of entities listed
  464.     Returns:    OSStatus                        *** list errors ***
  466.     Returns the list of entities of the specified class and type in the specified area. To obtain all 
  467.     entities regardless of their class or type pass kCfgClassAnyEntity or kCfgTypeAnyEntity. The 
  468.     count parameter should have the value obtained by CfgGetEntitiesCount.  On exit count may be less 
  469.     if some entities were deleted in the meantime. The id and info parameters should be arrays large 
  470.     enough to hold count entries. If the area doesn't exist or the wrong id is passed 
  471.     kCfgErrAreaNotFound is returned.  The info array contains information about each entity, 
  472.     including its class, type, name and the area of its icon:
  474.     struct CfgEntityInfo
  475.     {
  476.         CfgEntityClass      fClass;
  477.         CfgEntityType       fType;
  478.         ConstStr255Param    fName;
  479.         CfgResourceLocator  fIcon;
  480.     };
  481. */
  482. EXTERN_API( OSStatus )
  483. OTCfgCreateEntity               (CfgDatabaseRef         dbRef,
  484.                                  CfgAreaID              areaID,
  485.                                  const CfgEntityInfo *  entityInfo,
  486.                                  CfgEntityRef *         entityRef);
  488. /*
  489.     OTCfgCreateEntity()
  491.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  492.                 CfgAreaID areaID                ID of area to contain entity
  493.                 CfgEntityInfo* entityInfo       Information that defines the entity
  494.     Outputs:    CfgEntityRef* entityRef         Reference to entity created
  495.     Returns:    OSStatus                        *** list errors ***
  497.     Creates a new entity with the specified class, type and name and returns an id for it. If the 
  498.     area doesn't exist or the wrong id is passed kCfgErrAreaNotFound is returned. If there is already 
  499.     an entity with the same name kCfgErrEntityAlreadyExists is returned.
  500. */
  501. EXTERN_API( OSStatus )
  502. OTCfgDeleteEntity               (CfgDatabaseRef         dbRef,
  503.                                  const CfgEntityRef *   entityRef);
  505. /*
  506.     OTCfgDeleteEntity()
  508.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  509.                 CfgEntityRef* entityRef         Reference to entity to delete
  510.     Outputs:    none
  511.     Returns:    OSStatus                        *** list errors ***
  513.     Deletes the specified entity. If there is no entity with this id kCfgEntityNotfoundErr is returned
  514. */
  515. EXTERN_API( OSStatus )
  516. OTCfgDuplicateEntity            (CfgDatabaseRef         dbRef,
  517.                                  const CfgEntityRef *   entityRef,
  518.                                  const CfgEntityRef *   newEntityRef);
  520. /*
  521.     OTCfgDuplicateEntity()
  523.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  524.                 CfgEntityRef* entityRef         Reference to entity to duplicate
  525.     Outputs:    CfgEntityRef* newEntityRef      Reference to duplicate entity
  526.     Returns:    OSStatus                        *** list errors ***
  528.     Duplicates the specified entity. Both entities should exit. If any entity doesn't exist 
  529.     kCfgErrEntityNotFound is returned.
  530. */
  531. EXTERN_API( OSStatus )
  532. OTCfgSetEntityName              (CfgDatabaseRef         dbRef,
  533.                                  const CfgEntityRef *   entityRef,
  534.                                  ConstStr255Param       entityName,
  535.                                  CfgEntityRef *         newEntityRef);
  537. /*
  538.     OTCfgSetEntityName()
  540.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  541.                 CfgEntityRef* entityRef         Reference to entity to duplicate
  542.                 ConstStr255Param entityName     New name for entity
  543.     Outputs:    CfgEntityRef* newEntityRef      Reference to renamed entity
  544.     Returns:    OSStatus                        *** list errors ***
  546.     Renames the specified entity. If the entity doesn't exist kCfgEntityNotfoundErr is returned. If 
  547.     there is already an entity with that name kCfgErrEntityAlreadyExists is returned.
  548. */
  549. EXTERN_API( void )
  550. OTCfgGetEntityArea              (const CfgEntityRef *   entityRef,
  551.                                  CfgAreaID *            areaID);
  553. /*
  554.     OTCfgGetEntityArea()
  556.     Inputs:     CfgEntityRef *entityRef         Reference to an entity
  557.     Outputs:    CfgAreaID *areaID               ID of area that contains the entity
  558.     Returns:    none
  560.     Returns the area ID associated with the specified entity reference.
  561. */
  562. EXTERN_API( void )
  563. OTCfgGetEntityName              (const CfgEntityRef *   entityRef,
  564.                                  Str255                 entityName);
  566. /*
  567.     OTCfgGetEntityName()
  569.     Inputs:     CfgEntityRef *entityRef         Reference to an entity
  570.     Outputs:    Str255 entityName               Name of the entity
  571.     Returns:    none
  573.     Returns the entity name associated with the specified entity reference.
  574. */
  575. EXTERN_API( void )
  576. OTCfgChangeEntityArea           (CfgEntityRef *         entityRef,
  577.                                  CfgAreaID              newAreaID);
  579. /*
  580.     OTCfgChangeEntityArea()
  582.     Inputs:     CfgEntityRef *entityRef         Reference to an entity
  583.                 CfgAreaID newAreaID             ID of area to contain moved entity
  584.     Outputs:    none
  585.     Returns:    none
  587.     Changes the area ID associated with the specified entity reference. This effectively moves the 
  588.     entity to a different area.
  589. */
  590. /*    -------------------------------------------------------------------------
  591.     These API calls are for the protocol developers to compare the IDs.
  592.     ------------------------------------------------------------------------- */
  593. /*    -------------------------------------------------------------------------
  594.     For OTCfgIsSameEntityRef
  595.     ------------------------------------------------------------------------- */
  596. #endif  /* CALL_NOT_IN_CARBON */
  598. enum {
  599.     kOTCfgIgnoreArea            = kCfgIgnoreArea,
  600.     kOTCfgDontIgnoreArea        = kCfgDontIgnoreArea
  601. };
  603. #if CALL_NOT_IN_CARBON
  604. EXTERN_API( Boolean )
  605. OTCfgIsSameEntityRef            (const CfgEntityRef *   entityRef1,
  606.                                  const CfgEntityRef *   entityRef2,
  607.                                  Boolean                ignoreArea);
  609. /*
  610.     OTCfgIsSameEntityRef()
  612.     Inputs:     CfgEntityRef* entityRef1        Reference to an entity
  613.                 CfgEntityRef* entityRef2        Reference to another entity
  614.                 Boolean ignoreArea              If true, ignore the area ID
  615.     Outputs:    none
  616.     Returns:    Boolean                         If true, entity references match
  618.     Compare two entity references. If ignoreArea is true, and the two entity names are the same, then return 
  619.     true. If ignoreArea is false, then the area IDs must be the same, as well as the entity names 
  620.     must be the same, then can return true.
  621. */
  622. EXTERN_API( Boolean )
  623. OTCfgIsSameAreaID               (CfgAreaID              areaID1,
  624.                                  CfgAreaID              areaID2);
  626. /*
  627.     OTCfgIsSameAreaID()
  629.     Inputs:     CfgAreaID areaID1               ID of an area
  630.                 CfgAreaID areaID2               ID of another area
  631.     Outputs:    none
  632.     Returns:    Boolean                         If true, area IDs match
  634.     Compare two area IDs. Return true for matching area IDs, and return false for the different area IDs.
  635. */
  636. /*    -------------------------------------------------------------------------
  637.     Dealing with individual preferences
  638.     ------------------------------------------------------------------------- */
  639. /*    -------------------------------------------------------------------------
  640.     Open Preferences
  641.     if writer = true, GetPrefs and SetPrefs are allowed, else only GetPrefs is allowed.
  642.     ------------------------------------------------------------------------- */
  643. EXTERN_API( OSStatus )
  644. OTCfgOpenPrefs                  (CfgDatabaseRef         dbRef,
  645.                                  const CfgEntityRef *   entityRef,
  646.                                  Boolean                writer,
  647.                                  CfgEntityAccessID *    accessID);
  649. /*
  650.     OTCfgOpenPrefs()
  652.     Inputs:     CfgDatabaseRef dbRef            Reference to opened database
  653.                 CfgEntityRef* entityRef         Reference to an entity
  654.                 Boolean writer              If true, open for write
  655.     Outputs:    CfgEntityAccessID* accessID     ID for entity access
  656.     Returns:    OSStatus                        *** list errors ***
  658.     Open the specified entity and return the CfgEntityAccessID for the following access of the 
  659.     content of the entity. If writer is true, CfgGetPrefs and CfgSetPrefs are allowed, otherwise only 
  660.     CfgGetPrefs is allowed.
  661. */
  662. EXTERN_API( OSStatus )
  663. OTCfgClosePrefs                 (CfgEntityAccessID      accessID);
  665. /*
  666.     OTCfgClosePrefs()
  668.     Inputs:     CfgEntityAccessID* accessID     ID for entity to close
  669.     Outputs:    none
  670.     Returns:    OSStatus                        *** list errors ***
  672.     Close the entity with the specified CfgEntityAccessID.
  673. */
  674. /*    -------------------------------------------------------------------------
  675.     Get/Set Preferences
  677.     Accessing the content of an entity
  679.     These API calls are for the protocol developers. It supports multiple records per entity. Each 
  680.     record is identified by the prefsType and the size of the record. The protocol stack will provide 
  681.     the STRUCT to view the content of each record.
  682.     ------------------------------------------------------------------------- */
  683. EXTERN_API( OSStatus )
  684. OTCfgSetPrefs                   (CfgEntityAccessID      accessID,
  685.                                  OSType                 prefsType,
  686.                                  const void *           data,
  687.                                  ByteCount              length);
  689. /*
  690.     OTCfgSetPrefs()
  692.     Inputs:     CfgEntityAccessID* accessID     ID of entity to access
  693.                 OSType prefsType                Record type to set
  694.                 void* data                      Address of data
  695.                 ByteCount length                Number of bytes of data
  696.     Outputs:    none
  697.     Returns:    OSStatus                        *** list errors ***
  699.     Write the data to the specified record. The record is identified by the prefsType. If the entity 
  700.     is not opened for the writer, an error code is returned.
  701. */
  702. EXTERN_API( OSStatus )
  703. OTCfgGetPrefs                   (CfgEntityAccessID      accessID,
  704.                                  OSType                 prefsType,
  705.                                  void *                 data,
  706.                                  ByteCount              length);
  708. /*
  709.     OTCfgGetPrefs()
  711.     Inputs:     CfgEntityAccessID* accessID     ID of entity to access
  712.                 OSType prefsType                Record type to get
  713.                 void* data                      Address for data
  714.                 ByteCount length                Number of bytes of data requested
  715.     Outputs:    none
  716.     Returns:    OSStatus                        *** list errors ***
  718.     Read the data from the specified record to the passed buffer. The record is identified by the 
  719.     prefsType. If the passed buffer is too small, kCfgErrDataTruncated is returned, but will copy as 
  720.     many data as possible to the buffer.
  721. */
  722. EXTERN_API( OSStatus )
  723. OTCfgGetPrefsSize               (CfgEntityAccessID      accessID,
  724.                                  OSType                 prefsType,
  725.                                  ByteCount *            length);
  727. /*
  728.     OTCfgGetPrefsSize()
  730.     Inputs:     CfgEntityAccessID* accessID     ID of entity to access
  731.                 OSType prefsType                Record type to get
  732.                 ByteCount length                Number of bytes of data available
  733.     Outputs:    none
  734.     Returns:    OSStatus                        *** list errors ***
  736.     Returns the length, in bytes, of the specified record. The record is identified by the prefsType.
  737. */
  738. /*    -------------------------------------------------------------------------
  739.     Get table of contents for prefs
  740.     ------------------------------------------------------------------------- */
  741. EXTERN_API( OSStatus )
  742. OTCfgGetPrefsTOCCount           (CfgEntityAccessID      accessID,
  743.                                  ItemCount *            itemCount);
  745. /*
  746.     OTCfgGetPrefsTOCCount()
  748.     Inputs:     CfgEntityAccessID* accessID     ID of entity to access
  749.     Outputs:    ItemCount* itemCount            Number of entries available
  750.     Returns:    OSStatus                        *** list errors ***
  752.     Get the count of all the record headers in the entity. Return the number of records in the count. 
  753. */
  754. EXTERN_API( OSStatus )
  755. OTCfgGetPrefsTOC                (CfgEntityAccessID      accessID,
  756.                                  ItemCount *            itemCount,
  757.                                  CfgPrefsHeader         PrefsTOC[]);
  759. /*
  760.     OTCfgGetPrefsTOC()
  762.     Inputs:     CfgEntityAccessID* accessID     ID of entity to access
  763.                 ItemCount* itemCount            Number of entries requested
  764.     Outputs:    ItemCount* itemCount            Number of entries available
  765.                 CfgPrefsHeader PrefsTOC[]       Table of entries
  766.     Returns:    OSStatus                        *** list errors ***
  768.     Get the list of all the record headers in the entity. Return the number of records in the count. 
  769.     If the PrefsTOC is specified, it has to be big enough to hold all the record headers. If the 
  770.     PrefsTOC is null, only the count is returned.
  771. */
  772. EXTERN_API( SInt16 )
  773. OTCfgEncrypt                    (UInt8 *                key,
  774.                                  UInt8 *                data,
  775.                                  SInt16                 dataLen);
  777. /*
  778.     OTCfgEncrypt()
  780.     Inputs:     UInt8 *key                      encryption key ( user name )
  781.                 UInt8 *data                     data to encrypt ( password )
  782.                 SInt16 dataLen                  length of data to encrypt
  783.     Outputs:    UInt8 *data                     encrypted data
  784.     Returns:    SInt16                          length of encrypted data
  786.     Encrypt the password, using the user name as the encryption key.  Return the encrypted password and its length.  
  787. */
  788. EXTERN_API( SInt16 )
  789. OTCfgDecrypt                    (UInt8 *                key,
  790.                                  UInt8 *                data,
  791.                                  SInt16                 dataLen);
  793. /*
  794.     OTCfgDecrypt()
  796.     Inputs:     UInt8 *key                      encryption key ( user name )
  797.                 UInt8 *data                     data to decrypt ( password )
  798.                 SInt16 dataLen                  length of data to decrypt
  799.     Outputs:    UInt8 *data                     decrypted data
  800.     Returns:    SInt16                          length of decrypted data
  802.     Decrypt the password, using the user name as the encryption key.  Return the decrypted password and its length.  
  803. */
  804. EXTERN_API( Handle )
  805. OTCfgGetDefault                 (ResType                entityType,
  806.                                  ResType                entityClass,
  807.                                  ResType                recordType);
  809. #endif  /* CALL_NOT_IN_CARBON */
  811. #if CALL_NOT_IN_CARBON
  812. EXTERN_API( OSStatus )
  813. OTCfgInstallNotifier            (CfgDatabaseRef         dbRef,
  814.                                  CfgEntityClass         theClass,
  815.                                  CfgEntityType          theType,
  816.                                  OTNotifyProcPtr        notifier,
  817.                                  void *                 contextPtr);
  819. EXTERN_API( OSStatus )
  820. OTCfgRemoveNotifier             (CfgDatabaseRef         dbRef,
  821.                                  CfgEntityClass         theClass,
  822.                                  CfgEntityType          theType);
  824. #endif  /* CALL_NOT_IN_CARBON */
  827. typedef UInt16                          OTCfgIRPortSetting;
  828. enum {
  829.     kOTCfgTypeStruct            = FOUR_CHAR_CODE('stru'),
  830.     kOTCfgTypeElement           = FOUR_CHAR_CODE('elem'),
  831.     kOTCfgTypeVector            = FOUR_CHAR_CODE('vect')
  832. };
  834. /*    -------------------------------------------------------------------------
  835.     CfgEntityClass / CfgEntityType
  837.     The database can distinguish between several classes of objects and 
  838.     several types withing each class
  839.     Use of different classes allow to store type of information in the same database
  841.     Other entity classes and types can be defined by developers.
  842.     they should be unique and registered with Developer Tech Support (DTS)
  843.     ------------------------------------------------------------------------- */
  844. enum {
  845.     kOTCfgClassNetworkConnection = FOUR_CHAR_CODE('otnc'),
  846.     kOTCfgClassGlobalSettings   = FOUR_CHAR_CODE('otgl'),
  847.     kOTCfgClassServer           = FOUR_CHAR_CODE('otsv'),
  848.     kOTCfgTypeGeneric           = FOUR_CHAR_CODE('otan'),
  849.     kOTCfgTypeAppleTalk         = FOUR_CHAR_CODE('atlk'),
  850.     kOTCfgTypeTCPv4             = FOUR_CHAR_CODE('tcp4'),
  851.     kOTCfgTypeTCPv6             = FOUR_CHAR_CODE('tcp6'),
  852.     kOTCfgTypeRemote            = FOUR_CHAR_CODE('ara '),
  853.     kOTCfgTypeDial              = FOUR_CHAR_CODE('dial'),
  854.     kOTCfgTypeModem             = FOUR_CHAR_CODE('modm'),
  855.     kOTCfgTypeInfrared          = FOUR_CHAR_CODE('infr'),
  856.     kOTCfgClassSetOfSettings    = FOUR_CHAR_CODE('otsc'),
  857.     kOTCfgTypeSetOfSettings     = FOUR_CHAR_CODE('otst'),
  858.     kOTCfgTypeDNS               = FOUR_CHAR_CODE('dns ')
  859. };
  861. /*******************************************************************************
  862. ** Preferences Structures
  863. ********************************************************************************/
  864. enum {
  865.     kOTCfgIndexSetsActive       = 0,
  866.     kOTCfgIndexSetsEdit         = 1,
  867.     kOTCfgIndexSetsLimit        = 2                             /*    last value, no comma*/
  868. };
  871. struct CfgSetsStruct {
  872.     UInt32                          fFlags;
  873.     UInt32                          fTimes[2];
  874. };
  875. typedef struct CfgSetsStruct            CfgSetsStruct;
  877. struct CfgSetsElement {
  878.     CfgEntityRef                    fEntityRef;
  879.     CfgEntityInfo                   fEntityInfo;
  880. };
  881. typedef struct CfgSetsElement           CfgSetsElement;
  883. struct CfgSetsVector {
  884.     UInt32                          fCount;
  885.     CfgSetsElement                  fElements[1];
  886. };
  887. typedef struct CfgSetsVector            CfgSetsVector;
  888. /*  Common  */
  889. enum {
  890.                                                                 /*    connection */
  891.     kOTCfgTypeConfigName        = FOUR_CHAR_CODE('cnam'),
  892.     kOTCfgTypeConfigSelected    = FOUR_CHAR_CODE('ccfg'),       /*    transport options  */
  893.     kOTCfgTypeUserLevel         = FOUR_CHAR_CODE('ulvl'),
  894.     kOTCfgTypeWindowPosition    = FOUR_CHAR_CODE('wpos')
  895. };
  897. /*  AppleTalk   */
  898. enum {
  899.                                                                 /*    connection */
  900.     kOTCfgTypeAppleTalkPrefs    = FOUR_CHAR_CODE('atpf'),
  901.     kOTCfgTypeAppleTalkVersion  = FOUR_CHAR_CODE('cvrs'),
  902.     kOTCfgTypeAppleTalkLocks    = FOUR_CHAR_CODE('lcks'),
  903.     kOTCfgTypeAppleTalkPort     = FOUR_CHAR_CODE('port'),
  904.     kOTCfgTypeAppleTalkProtocol = FOUR_CHAR_CODE('prot'),
  905.     kOTCfgTypeAppleTalkPassword = FOUR_CHAR_CODE('pwrd'),
  906.     kOTCfgTypeAppleTalkPortFamily = FOUR_CHAR_CODE('ptfm')      /*    transport options  */
  907. };
  909. enum {
  910.     kOTCfgIndexAppleTalkAARP    = 0,
  911.     kOTCfgIndexAppleTalkDDP     = 1,
  912.     kOTCfgIndexAppleTalkNBP     = 2,
  913.     kOTCfgIndexAppleTalkZIP     = 3,
  914.     kOTCfgIndexAppleTalkATP     = 4,
  915.     kOTCfgIndexAppleTalkADSP    = 5,
  916.     kOTCfgIndexAppleTalkPAP     = 6,
  917.     kOTCfgIndexAppleTalkASP     = 7,
  918.     kOTCfgIndexAppleTalkLast    = 7
  919. };
  922. struct OTCfgAppleTalkPrefs {
  923.     UInt16                          fVersion;
  924.     UInt16                          fNumPrefs;
  925.     OTPortRef                       fPort;
  926.     void *                          fLink;
  927.     void *                          fPrefs[8];
  928. };
  929. typedef struct OTCfgAppleTalkPrefs      OTCfgAppleTalkPrefs;
  931. struct OTCfgAARPPrefs {
  932.     UInt16                          fVersion;
  933.     UInt16                          fSize;
  934.     UInt32                          fAgingCount;
  935.     UInt32                          fAgingInterval;
  936.     OTByteCount                     fProtAddrLen;
  937.     OTByteCount                     fHWAddrLen;
  938.     UInt32                          fMaxEntries;
  939.     OTByteCount                     fProbeInterval;
  940.     OTByteCount                     fProbeRetryCount;
  941.     OTByteCount                     fRequestInterval;
  942.     OTByteCount                     fRequestRetryCount;
  943. };
  944. typedef struct OTCfgAARPPrefs           OTCfgAARPPrefs;
  946. struct OTCfgDDPPrefs {
  947.     UInt16                          fVersion;
  948.     UInt16                          fSize;
  949.     UInt32                          fTSDUSize;
  950.     UInt8                           fLoadType;
  951.     UInt8                           fNode;
  952.     UInt16                          fNetwork;
  953.     UInt16                          fRTMPRequestLimit;
  954.     UInt16                          fRTMPRequestInterval;
  955.     UInt32                          fAddressGenLimit;
  956.     UInt32                          fBRCAgingInterval;
  957.     UInt32                          fRTMPAgingInterval;
  958.     UInt32                          fMaxAddrTries;
  959.     Boolean                         fDefaultChecksum;
  960.     Boolean                         fIsFixedNode;
  961.     UInt8                           fMyZone[33];
  962. };
  963. typedef struct OTCfgDDPPrefs            OTCfgDDPPrefs;
  965. struct OTCfgATPFPrefs {
  966.     OTCfgAppleTalkPrefs             fAT;
  967.     OTCfgAARPPrefs                  fAARP;
  968.     OTCfgDDPPrefs                   fDDP;
  969.     char                            fFill[122];
  970. };
  971. typedef struct OTCfgATPFPrefs           OTCfgATPFPrefs;
  972. /*  Infrared    */
  973. enum {
  974.     kOTCfgTypeInfraredPrefs     = FOUR_CHAR_CODE('atpf'),
  975.     kOTCfgTypeInfraredGlobal    = FOUR_CHAR_CODE('irgo')
  976. };
  979. struct OTCfgIRPrefs {
  980.     CfgPrefsHeader                  fHdr;
  981.     OTPortRef                       fPort;                      /*    OT port id*/
  982.     OTCfgIRPortSetting              fPortSetting;               /*    Ir protocol,  irda or irtalk*/
  983.     Boolean                         fNotifyOnDisconnect;        /*    notify user on irda disconnect?*/
  984.     Boolean                         fDisplayIRControlStrip;     /*    show ir control strip?*/
  985.     Point                           fWindowPosition;            /*    The position of the editor window*/
  986. };
  987. typedef struct OTCfgIRPrefs             OTCfgIRPrefs;
  989. struct OTCfgIRGlobal {
  990.     CfgPrefsHeader                  fHdr;                       /* standard prefererences header*/
  991.     UInt32                          fOptions;                   /* options bitmask*/
  992.     UInt32                          fNotifyMask;                /* Notification options.*/
  993.     UInt32                          fUnloadTimeout;             /* Unload timeout (in milliseconds)*/
  994. };
  995. typedef struct OTCfgIRGlobal            OTCfgIRGlobal;
  996. /*  TCP/IP v4   */
  997. enum {
  998.                                                                 /*    connection */
  999.     kOTCfgTypeTCPalis           = FOUR_CHAR_CODE('alis'),
  1000.     kOTCfgTypeTCPcvrs           = FOUR_CHAR_CODE('cvrs'),
  1001.     kOTCfgTypeTCPdcid           = FOUR_CHAR_CODE('dcid'),
  1002.     kOTCfgTypeTCPdclt           = FOUR_CHAR_CODE('dclt'),
  1003.     kOTCfgTypeTCPdtyp           = FOUR_CHAR_CODE('dtyp'),
  1004.     kOTCfgTypeTCPidns           = FOUR_CHAR_CODE('idns'),
  1005.     kOTCfgTypeTCPihst           = FOUR_CHAR_CODE('ihst'),
  1006.     kOTCfgTypeTCPiitf           = FOUR_CHAR_CODE('iitf'),
  1007.     kOTCfgTypeTCPara            = FOUR_CHAR_CODE('ipcp'),
  1008.     kOTCfgTypeTCPirte           = FOUR_CHAR_CODE('irte'),
  1009.     kOTCfgTypeTCPisdm           = FOUR_CHAR_CODE('isdm'),
  1010.     kOTCfgTypeTCPstng           = FOUR_CHAR_CODE('stng'),
  1011.     kOTCfgTypeTCPunld           = FOUR_CHAR_CODE('unld'),
  1012.     kOTCfgTypeTCPVersion        = FOUR_CHAR_CODE('cvrs'),       /*    Version */
  1013.     kOTCfgTypeTCPDevType        = FOUR_CHAR_CODE('dvty'),
  1014.     kOTCfgTypeTCPPrefs          = FOUR_CHAR_CODE('iitf'),
  1015.     kOTCfgTypeTCPServersList    = FOUR_CHAR_CODE('idns'),
  1016.     kOTCfgTypeTCPSearchList     = FOUR_CHAR_CODE('ihst'),
  1017.     kOTCfgTypeTCPRoutersList    = FOUR_CHAR_CODE('irte'),
  1018.     kOTCfgTypeTCPDomainsList    = FOUR_CHAR_CODE('isdm'),
  1019.     kOTCfgTypeTCPPort           = FOUR_CHAR_CODE('port'),       /*    Ports */
  1020.     kOTCfgTypeTCPProtocol       = FOUR_CHAR_CODE('prot'),
  1021.     kOTCfgTypeTCPPassword       = FOUR_CHAR_CODE('pwrd'),       /*    Password */
  1022.     kOTCfgTypeTCPLocks          = FOUR_CHAR_CODE('stng'),       /*    locks */
  1023.     kOTCfgTypeTCPUnloadType     = FOUR_CHAR_CODE('unld')        /*    transport options  */
  1024. };
  1028. struct OTCfgIDNSPrefs {
  1029.     short                           fCount;
  1030.     InetHost                        fAddressesList;
  1031. };
  1032. typedef struct OTCfgIDNSPrefs           OTCfgIDNSPrefs;
  1034. struct OTCfgHSTFPrefs {
  1035.     char                            fPrimaryInterfaceIndex;     /*    always 1 in OT 1.0 / 1.1*/
  1036.                                                                 /*    this structure IS packed!*/
  1037.     UInt8                           fLocalDomainName[256];
  1038.                                                                 /*    followed by */
  1039.     UInt8                           admindomain[256];
  1040. };
  1041. typedef struct OTCfgHSTFPrefs           OTCfgHSTFPrefs;
  1042. /*  This is your worst case, a fixed size structure, tacked on after a variable length string.*/
  1043. /*  Use the macro to help access the movable beast. */
  1045. #define kIITFPartP( h ) ( (OTCfgIITFPrefsPart*) &( (**( (OTCfgIITFPrefs**) h )).fAppleTalkZone[ (**( (OTCfgIITFPrefs**) h )).fAppleTalkZone[0] + 1 ] ) )
  1047. /*
  1048.     This structure also contains an IP address and subnet mask that are not aligned on a four byte boundary.  
  1049.     In order to avoid compiler warnings, and the possibility of code that won't work, 
  1050.     these fields are defined here as four character arrays.  
  1051.     It is suggested that BlockMoveData be used to copy to and from a field of type InetHost.  
  1052. */
  1054. struct OTCfgIITFPrefsPart {
  1055.     char                            path[36];
  1056.     char                            module[32];
  1057.     unsigned long                   framing;
  1058. };
  1059. typedef struct OTCfgIITFPrefsPart       OTCfgIITFPrefsPart;
  1061. struct OTCfgIITFPrefs {
  1062.     short                           fCount;
  1063.     UInt8                           fConfigMethod;
  1064.                                                                 /*    this structure IS packed!*/
  1065.                                                                 /*    Followed by:*/
  1066.     UInt8                           fIPAddress[4];
  1067.     UInt8                           fSubnetMask[4];
  1068.     UInt8                           fAppleTalkZone[256];
  1069.                                                                 /*    this structure IS packed!*/
  1070.     UInt8                           fFiller;
  1071.     OTCfgIITFPrefsPart              part;
  1072. };
  1073. typedef struct OTCfgIITFPrefs           OTCfgIITFPrefs;
  1075. struct OTCfgIRTEEntry {
  1076.     InetHost                        fToHost;                    /*    always 0;*/
  1077.     InetHost                        fViaHost;                   /*    router address;*/
  1078.     short                           fLocal;                     /*    always 0*/
  1079.     short                           fHost;                      /*    always 0*/
  1080. };
  1081. typedef struct OTCfgIRTEEntry           OTCfgIRTEEntry;
  1083. struct OTCfgIRTEPrefs {
  1084.     short                           fCount;
  1085.     OTCfgIRTEEntry                  fList[1];
  1086. };
  1087. typedef struct OTCfgIRTEPrefs           OTCfgIRTEPrefs;
  1089. struct OTCfgISDMPrefs {
  1090.     short                           fCount;
  1091.     Str255                          fDomainsList;
  1092. };
  1093. typedef struct OTCfgISDMPrefs           OTCfgISDMPrefs;
  1095. struct OTCfgDHCPRecord {
  1096.     InetHost                        ipIPAddr;
  1097.     InetHost                        ipConfigServer;
  1098.     UInt32                          ipLeaseGrantTime;
  1099.     UInt32                          ipLeaseExpirationTime;
  1100. };
  1101. typedef struct OTCfgDHCPRecord          OTCfgDHCPRecord;
  1102. /*  DNS */
  1103. enum {
  1104.                                                                 /*    connection */
  1105.     kOTCfgTypeDNSidns           = FOUR_CHAR_CODE('idns'),
  1106.     kOTCfgTypeDNSisdm           = FOUR_CHAR_CODE('isdm'),
  1107.     kOTCfgTypeDNSihst           = FOUR_CHAR_CODE('ihst'),
  1108.     kOTCfgTypeDNSstng           = FOUR_CHAR_CODE('stng'),
  1109.     kOTCfgTypeDNSPassword       = FOUR_CHAR_CODE('pwrd')        /*    transport options  */
  1110. };
  1112. /*  Modem   */
  1113. enum {
  1114.                                                                 /*    connection */
  1115.     kOTCfgTypeModemModem        = FOUR_CHAR_CODE('ccl '),       /*    Type for Modem configuration resource*/
  1116.     kOTCfgTypeModemLocks        = FOUR_CHAR_CODE('lkmd'),       /*    Types for lock resources*/
  1117.     kOTCfgTypeModemAdminPswd    = FOUR_CHAR_CODE('mdpw'),       /*    Password*/
  1118.                                                                 /*    transport options  */
  1119.     kOTCfgTypeModemApp          = FOUR_CHAR_CODE('mapt')
  1120. };
  1123. struct OTCfgRemoteConfigModem {
  1124.     UInt32                          version;
  1125.     Boolean                         useModemScript;
  1126.     char                            pad00;                      /*    this structure is NOT packed!*/
  1127.     FSSpec                          modemScript;
  1128.     Boolean                         modemSpeakerOn;
  1129.     Boolean                         modemPulseDial;
  1130.     UInt32                          modemDialToneMode;
  1131.     SInt8                           lowerLayerName[36];
  1132. };
  1133. typedef struct OTCfgRemoteConfigModem   OTCfgRemoteConfigModem;
  1135. struct OTCfgModemLocks {
  1136.     UInt32                          version;
  1137.     UInt32                          port;
  1138.     UInt32                          script;
  1139.     UInt32                          speaker;
  1140.     UInt32                          dialing;
  1141. };
  1142. typedef struct OTCfgModemLocks          OTCfgModemLocks;
  1144. struct OTCfgModemAppPrefs {
  1145.     UInt32                          version;
  1146.     Point                           windowPos;
  1147.     SInt32                          userMode;
  1148. };
  1149. typedef struct OTCfgModemAppPrefs       OTCfgModemAppPrefs;
  1150. /*  Remote Access   */
  1151. enum {
  1152.                                                                 /*    connection */
  1153.     kOTCfgTypeRemoteARAP        = FOUR_CHAR_CODE('arap'),
  1154.     kOTCfgTypeRemoteAddress     = FOUR_CHAR_CODE('cadr'),
  1155.     kOTCfgTypeRemoteChat        = FOUR_CHAR_CODE('ccha'),
  1156.     kOTCfgTypeRemoteDialing     = FOUR_CHAR_CODE('cdia'),
  1157.     kOTCfgTypeRemoteExtAddress  = FOUR_CHAR_CODE('cead'),
  1158.     kOTCfgTypeRemoteClientLocks = FOUR_CHAR_CODE('clks'),
  1159.     kOTCfgTypeRemoteClientMisc  = FOUR_CHAR_CODE('cmsc'),
  1160.     kOTCfgTypeRemoteConnect     = FOUR_CHAR_CODE('conn'),
  1161.     kOTCfgTypeRemoteUser        = FOUR_CHAR_CODE('cusr'),
  1162.     kOTCfgTypeRemoteDialAssist  = FOUR_CHAR_CODE('dass'),
  1163.     kOTCfgTypeRemoteIPCP        = FOUR_CHAR_CODE('ipcp'),
  1164.     kOTCfgTypeRemoteLCP         = FOUR_CHAR_CODE('lcp '),       /* trailing space is important! */
  1165.     kOTCfgTypeRemoteLogOptions  = FOUR_CHAR_CODE('logo'),
  1166.     kOTCfgTypeRemotePassword    = FOUR_CHAR_CODE('pass'),
  1167.     kOTCfgTypeRemotePort        = FOUR_CHAR_CODE('port'),
  1168.     kOTCfgTypeRemoteServerLocks = FOUR_CHAR_CODE('slks'),
  1169.     kOTCfgTypeRemoteServer      = FOUR_CHAR_CODE('srvr'),
  1170.     kOTCfgTypeRemoteUserMode    = FOUR_CHAR_CODE('usmd'),
  1171.     kOTCfgTypeRemoteX25         = FOUR_CHAR_CODE('x25 '),       /* trailing space is important! */
  1172.                                                                 /*    transport options  */
  1173.     kOTCfgTypeRemoteApp         = FOUR_CHAR_CODE('capt')
  1174. };
  1176. /*******************************************************************************
  1177. *   OTCfgRemoteLogOptions
  1178. *
  1179. *   This structure is appended to OTCfgRemoteConnect records in the 
  1180. *   OTCfgRemoteConnect::additional list.
  1181. *
  1182. *   NOTE
  1183. *
  1184. *   All OTCfgRemoteConnect::additional structures MUST have the same fields up to
  1185. *   the "additional" field.  See OTCfgRemoteX25Info.
  1186. ********************************************************************************/
  1188. struct OTCfgRemoteLogOptions {
  1189.     UInt32                          version;
  1190.     UInt32                          fType;                      /*    kRAConnectAdditionalLogOptions*/
  1191.     void *                          additional;
  1192.     UInt32                          logLevel;                   /*    values defined above.*/
  1193.     UInt32                          reserved[4];                /*    for later use.*/
  1194. };
  1195. typedef struct OTCfgRemoteLogOptions    OTCfgRemoteLogOptions;
  1196. /*******************************************************************************
  1197. *   New structures for dialing mode, phone numbers, and configuration stats.
  1198. *   
  1199. *   
  1200. ********************************************************************************/
  1201. enum {
  1202.     kOTCfgRemoteMaxAddressSize  = (255 + 1)
  1203. };
  1206. struct OTCfgRemoteAddress {
  1207.     struct OTCfgRemoteAddress *     next;
  1208.     UInt8                           address[256];
  1209. };
  1210. typedef struct OTCfgRemoteAddress       OTCfgRemoteAddress;
  1211. /*******************************************************************************
  1212. *   OTCfgRemoteDialing
  1213. *
  1214. *   This structure is appended to OTCfgRemoteConnect records in the 
  1215. *   OTCfgRemoteConnect::additional list.
  1216. *
  1217. *   NOTE
  1218. *
  1219. *   All OTCfgRemoteConnect::additional structures MUST have the same fields up to
  1220. *   the "additional" field.  See OTCfgRemoteX25Info.
  1221. ********************************************************************************/
  1223. struct OTCfgRemoteDialing {
  1224.     UInt32                          version;
  1225.     UInt32                          fType;                      /*    kRAConnectAdditionalDialing*/
  1226.     void *                          additional;
  1227.     UInt32                          dialMode;                   /*    values defined above.*/
  1228.     SInt32                          redialTries;
  1229.     UInt32                          redialDelay;                /*    in seconds.*/
  1230.     OTCfgRemoteAddress *            addresses;
  1231. };
  1232. typedef struct OTCfgRemoteDialing       OTCfgRemoteDialing;
  1233. /*******************************************************************************
  1234. *   OTCfgRemoteScript
  1235. *
  1236. *   This is appended to OTCfgRemoteConnect records in the "additional" list.
  1237. *   It is currently only used for passing in a modem script to override
  1238. *   the default script.  Connect scripts have their own field in OTCfgRemoteConnect.
  1239. *
  1240. *   NOTE
  1241. *
  1242. *   All OTCfgRemoteConnect::additional structures MUST have the same fields up to
  1243. *   the "additional" field.  See OTCfgRemoteX25Info and OTCfgRemoteDialing.
  1244. ********************************************************************************/
  1246. struct OTCfgRemoteScript {
  1247.     UInt32                          version;
  1248.     UInt32                          fType;                      /*    kRAConnectAdditionalScript*/
  1249.     void *                          additional;
  1250.     UInt32                          scriptType;
  1251.     UInt32                          scriptLength;
  1252.     UInt8 *                         scriptData;
  1253. };
  1254. typedef struct OTCfgRemoteScript        OTCfgRemoteScript;
  1255. /*******************************************************************************
  1256. *   Miscellaneous limits
  1257. *   The size limits for strings include a 1 byte for the string length or
  1258. *   a terminating NULL character.
  1259. ********************************************************************************/
  1260. enum {
  1261.     kOTCfgRemoteMaxPasswordLength = 255,
  1262.     kOTCfgRemoteMaxPasswordSize = (255 + 1),
  1263.     kOTCfgRemoteMaxUserNameLength = 255,
  1264.     kOTCfgRemoteMaxUserNameSize = (255 + 1),
  1265.     kOTCfgRemoteMaxAddressLength = 255,                         /*    kOTCfgRemoteMaxAddressSize           = (255 + 1),*/
  1266.     kOTCfgRemoteMaxServerNameLength = 32,
  1267.     kOTCfgRemoteMaxServerNameSize = (32 + 1),
  1268.     kOTCfgRemoteMaxMessageLength = 255,
  1269.     kOTCfgRemoteMaxMessageSize  = (255 + 1),
  1270.     kOTCfgRemoteMaxX25ClosedUserGroupLength = 4,
  1271.     kOTCfgRemoteInfiniteSeconds = (long)0xFFFFFFFF,
  1272.     kOTCfgRemoteMinReminderMinutes = 1,
  1273.     kOTCfgRemoteChatScriptFileCreator = FOUR_CHAR_CODE('ttxt'),
  1274.     kOTCfgRemoteChatScriptFileType = FOUR_CHAR_CODE('TEXT'),
  1275.     kOTCfgRemoteMaxChatScriptLength = 0x8000
  1276. };
  1278. /*******************************************************************************
  1279. *   X.25 connection information, added to OTCfgRemoteConnect's additional info list.
  1280. *
  1281. *   NOTE
  1282. *
  1283. *   All OTCfgRemoteConnect::additional structures MUST have the same fields up to
  1284. *   the "additional" field.  See OTCfgRemoteScript & OTCfgRemoteDialing.
  1285. ********************************************************************************/
  1287. struct OTCfgRemoteX25Info {
  1288.     UInt32                          version;
  1289.     UInt32                          fType;                      /*    kRAConnectAdditionalX25*/
  1290.     void *                          additional;                 /*    Ptr to additional connect info*/
  1291.     FSSpec                          script;                     /*    PAD's CCL script*/
  1292.     UInt8                           address[256];               /*    address of server*/
  1293.     UInt8                           userName[256];
  1294.                                                                 /*    network user ID*/
  1295.     UInt8                           closedUserGroup[5];
  1296.                                                                 /*    closed user group*/
  1297.     Boolean                         reverseCharge;              /*    request reverse charging*/
  1298. };
  1299. typedef struct OTCfgRemoteX25Info       OTCfgRemoteX25Info;
  1300. /*******************************************************************************
  1301. *   OTCfgRemoteDisconnect
  1302. *
  1303. *   Use this structure to terminate Remote Access connections.
  1304. ********************************************************************************/
  1306. struct OTCfgRemoteDisconnect {
  1307.     UInt32                          whenSeconds;                /*    Number of seconds until disconnect*/
  1308.     UInt32                          showStatus;                 /*    Show disconnect status window*/
  1309. };
  1310. typedef struct OTCfgRemoteDisconnect    OTCfgRemoteDisconnect;
  1311. /*******************************************************************************
  1312. *   OTCfgRemoteIsRemote
  1313. *
  1314. *   Use this structure to find out if an AppleTalk address is on the 
  1315. *   remote side of the current ARA link. The "isRemote" field is set to
  1316. *   "true" if the address is remote. 
  1317. ********************************************************************************/
  1319. struct OTCfgRemoteIsRemote {
  1320.     UInt32                          net;                        /*    AppleTalk network number*/
  1321.     UInt32                          node;                       /*    AppleTalk node number*/
  1322.     UInt32                          isRemote;                   /*    returned.*/
  1323. };
  1324. typedef struct OTCfgRemoteIsRemote      OTCfgRemoteIsRemote;
  1325. /*******************************************************************************
  1326. *   OTCfgRemoteConnect
  1327. *
  1328. *   Use this structure to initiate Remote Access connections.
  1329. ********************************************************************************/
  1331. struct OTCfgRemoteConnect {
  1332.     UInt32                          version;
  1333.     UInt32                          fType;                      /*    RAConnectType defined above.*/
  1334.     UInt32                          isGuest;                    /*    (boolean) True for guest login*/
  1335.     UInt32                          canInteract;                /*    (boolean) True if dialogs can be displayed*/
  1336.     UInt32                          showStatus;                 /*    (boolean) Display (dis)connection status dialogs?*/
  1337.     UInt32                          passwordSaved;              /*    (boolean) "Save Password" checked in doc.*/
  1338.     UInt32                          flashConnectedIcon;         /*    (boolean) Flash icon in menu bar*/
  1339.     UInt32                          issueConnectedReminders;    /*    (boolean) Use Notification Manager reminders*/
  1340.     SInt32                          reminderMinutes;            /*    How long between each reminder?*/
  1341.     UInt32                          connectManually;            /*    (boolean) True if we are connecting manually*/
  1342.     UInt32                          allowModemDataCompression;  /*    (boolean) currently, only for kSerialProtoPPP*/
  1343.     UInt32                          chatMode;                   /*    Flags defined above*/
  1344.     UInt32                          serialProtocolMode;         /*    Flags defined above*/
  1346.     UInt8 *                         password;
  1347.     UInt8 *                         userName;
  1348.     UInt32                          addressLength;              /*    Length of phone number or other address*/
  1349.     UInt8 *                         address;                    /*    Phone number or address data*/
  1350.     Str63                           chatScriptName;             /*    Name of imported chat script (informational only)*/
  1351.     UInt32                          chatScriptLength;           /*    Length of Chat script*/
  1352.     UInt8 *                         chatScript;                 /*    Chat script data*/
  1354.     void *                          additional;                 /*    Ptr to additional connect info,*/
  1355.                                                                 /*    such as OTCfgRemoteX25Info*/
  1357.     UInt32                          useSecurityModule;          /*    (boolean) use line-level security module ?*/
  1358.     OSType                          securitySignature;          /*    signature of security module file*/
  1359.     UInt32                          securityDataLength;         /*    0..kSecurityMaxConfigData*/
  1360.     UInt8 *                         securityData;               /*    Ptr to data of size securityDataLength*/
  1361. };
  1362. typedef struct OTCfgRemoteConnect       OTCfgRemoteConnect;
  1363. /*******************************************************************************
  1364. *   OTCfgRemoteConnectInfo
  1365. *
  1366. *   If requestCode = kRAGetConnectInfo, "connectInfo" returns a pointer to a
  1367. *   new OTCfgRemoteConnect block that describes the current connection.
  1368. *
  1369. *   If requestCode = kRADisposeConnectInfo, the memory pointed to by
  1370. *   "connectInfo" is released for reuse.  "connectInfo" must point to a valid
  1371. *   OTCfgRemoteConnect structure previously returned by kRAGetConnectInfo.
  1372. ********************************************************************************/
  1374. struct OTCfgRemoteConnectInfo {
  1375.     OTCfgRemoteConnect *            connectInfo;                /*    Returned or disposed, depending on requestCode*/
  1376. };
  1377. typedef struct OTCfgRemoteConnectInfo   OTCfgRemoteConnectInfo;
  1378. /*******************************************************************************
  1379. *   OTCfgRemoteStatus
  1380. *
  1381. *   Use this structure to get the status of Remote Access connections.
  1382. ********************************************************************************/
  1383. enum {
  1384.     kOTCfgRemoteStatusIdle      = 1,
  1385.     kOTCfgRemoteStatusConnecting = 2,
  1386.     kOTCfgRemoteStatusConnected = 3,
  1387.     kOTCfgRemoteStatusDisconnecting = 4
  1388. };
  1392. struct OTCfgRemoteStatus {
  1393.     UInt32                          status;                     /*    values defined above*/
  1394.     Boolean                         answerEnabled;
  1395.     char                            pad00;                      /*    This structure is NOT packed*/
  1396.     UInt32                          secondsConnected;
  1397.     UInt32                          secondsRemaining;
  1398.     UInt8                           userName[256];              /*    Pascal format*/
  1399.     UInt8                           serverName[33];             /*    Pascal format*/
  1400.     char                            pad01;                      /*    This structure is NOT packed*/
  1401.     UInt32                          messageIndex;
  1402.     UInt8                           message[256];               /*    Pascal format*/
  1403.     UInt32                          serialProtocolMode;         /*    Flags defined above.*/
  1404.     UInt8                           baudMessage[256];           /*    Pascal format*/
  1405.     Boolean                         isServer;
  1406.     char                            pad02;                      /*    This structure is NOT packed*/
  1407.     UInt32                          bytesIn;
  1408.     UInt32                          bytesOut;
  1409.     UInt32                          linkSpeed;
  1410.     UInt32                          localIPAddress;
  1411.     UInt32                          remoteIPAddress;
  1412. };
  1413. typedef struct OTCfgRemoteStatus        OTCfgRemoteStatus;
  1414. /*******************************************************************************
  1415. *   OTCfgRemoteUserMessage
  1416. *
  1417. *   Use this structure when converting result codes into user messages.
  1418. ********************************************************************************/
  1420. struct OTCfgRemoteUserMessage {
  1421.     UInt32                          version;
  1422.     SInt32                          messageID;
  1423.     UInt8                           userMessage[256];
  1424.     UInt8                           userDiagnostic[256];
  1425. };
  1426. typedef struct OTCfgRemoteUserMessage   OTCfgRemoteUserMessage;
  1427. /*******************************************************************************
  1428. *   OTCfgRemoteNotifier
  1429. *
  1430. *   Use this structure to install a procedure to receive asynchronous 
  1431. *   Remote Access notifications.
  1432. ********************************************************************************/
  1434. typedef UInt32                          OTCfgRemoteEventCode;
  1435. typedef CALLBACK_API_C( void , RANotifyProcPtr )(void *contextPtr, OTCfgRemoteEventCode code, OSStatus result, void *cookie);
  1437. struct OTCfgRemoteNotifier {
  1438.     RANotifyProcPtr                 procPtr;
  1439.     void *                          contextPtr;
  1440. };
  1441. typedef struct OTCfgRemoteNotifier      OTCfgRemoteNotifier;
  1442. /*******************************************************************************
  1443. *   OTCfgRemoteRequest
  1444. *
  1445. *   All Remote Access API calls must pass a pointer to an OTCfgRemoteRequest structure.
  1446. ********************************************************************************/
  1448. struct OTCfgRemoteRequest {
  1449.     SInt8                           reserved1[16];              /*    Do not use. */
  1450.     OSErr                           result;                     /*    <--*/
  1451.     SInt8                           reserved2[8];               /*    Do not use.*/
  1452.     SInt16                          requestCode;                /*     -->*/
  1453.     SInt16                          portId;                     /*    <-->*/
  1454.     union {
  1455.         OTCfgRemoteNotifier             Notifier;
  1456.         OTCfgRemoteConnect              Connect;
  1457.         OTCfgRemoteDisconnect           Disconnect;
  1458.         OTCfgRemoteStatus               Status;
  1459.         OTCfgRemoteIsRemote             IsRemote;
  1460.         OTCfgRemoteConnectInfo          ConnectInfo;
  1461.     }                                 fType;
  1462. };
  1463. typedef struct OTCfgRemoteRequest       OTCfgRemoteRequest;
  1465. struct OTCfgRemoteConfigCAPT {
  1466.     UInt32                          fWord1;
  1467.     Point                           fWindowPosition;
  1468.     UInt32                          fWord3;
  1469.     UInt32                          fUserLevel;
  1470.     UInt32                          fSetupVisible;
  1471. };
  1472. typedef struct OTCfgRemoteConfigCAPT    OTCfgRemoteConfigCAPT;
  1473. #endif  /* CALL_NOT_IN_CARBON */
  1476. #if PRAGMA_STRUCT_ALIGN
  1477.     #pragma options align=reset
  1478. #elif PRAGMA_STRUCT_PACKPUSH
  1479.     #pragma pack(pop)
  1480. #elif PRAGMA_STRUCT_PACK
  1481.     #pragma pack()
  1482. #endif
  1484. #ifdef PRAGMA_IMPORT_OFF
  1485. #pragma import off
  1486. #elif PRAGMA_IMPORT
  1487. #pragma import reset
  1488. #endif
  1490. #ifdef __cplusplus
  1491. }
  1492. #endif
  1494. #endif /* __NETWORKSETUP__ */