home *** CD-ROM | disk | FTP | other *** search
/ QuickTime 2.0 Developer Kit / QuickTime 2.0 Developer Kit.iso / mac / MAC / Programming Stuff / Interfaces / PInterfaces / DatabaseAccess.p < prev    next >
Encoding:
Text File  |  1994-11-11  |  10.7 KB  |  319 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        DatabaseAccess.p
  3.  
  4.      Copyright:    © 1984-1994 by Apple Computer, Inc.
  5.                  All rights reserved.
  6.  
  7.      Version:    Universal Interfaces 2.0a3  ETO #16, MPW prerelease.  Friday, November 11, 1994. 
  8.  
  9.      Bugs?:        If you find a problem with this file, send the file and version
  10.                  information (from above) and the problem description to:
  11.  
  12.                      Internet:    apple.bugs@applelink.apple.com
  13.                      AppleLink:    APPLE.BUGS
  14.  
  15. }
  16.  
  17. {$IFC UNDEFINED UsingIncludes}
  18. {$SETC UsingIncludes := 0}
  19. {$ENDC}
  20.  
  21. {$IFC NOT UsingIncludes}
  22.  UNIT DatabaseAccess;
  23.  INTERFACE
  24. {$ENDC}
  25.  
  26. {$IFC UNDEFINED __DATABASEACCESS__}
  27. {$SETC __DATABASEACCESS__ := 1}
  28.  
  29. {$I+}
  30. {$SETC DatabaseAccessIncludes := UsingIncludes}
  31. {$SETC UsingIncludes := 1}
  32.  
  33.  
  34. {$IFC UNDEFINED __RESOURCES__}
  35. {$I Resources.p}
  36. {$ENDC}
  37. {    Types.p                                                        }
  38. {        ConditionalMacros.p                                        }
  39. {    MixedMode.p                                                    }
  40. {    Files.p                                                        }
  41. {        OSUtils.p                                                }
  42. {            Memory.p                                            }
  43.  
  44. {$PUSH}
  45. {$ALIGN MAC68K}
  46. {$LibExport+}
  47.  
  48. CONST
  49.     typeNone                    = 'none';
  50.     typeDate                    = 'date';
  51.     typeTime                    = 'time';
  52.     typeTimeStamp                = 'tims';
  53.     typeDecimal                    = 'deci';
  54.     typeMoney                    = 'mone';
  55.     typeVChar                    = 'vcha';
  56.     typeVBin                    = 'vbin';
  57.     typeLChar                    = 'lcha';
  58.     typeLBin                    = 'lbin';
  59.     typeDiscard                    = 'disc';
  60. { "dummy" types for DBResultsToText }
  61.     typeUnknown                    = 'unkn';
  62.     typeColBreak                = 'colb';
  63.     typeRowBreak                = 'rowb';
  64. { pass this in to DBGetItem for any data type }
  65.     typeAnyType                    = 0;
  66.  
  67. { infinite timeout value for DBGetItem }
  68. { messages for status functions for DBStartQuery }
  69.     kDBUpdateWind                = 0;
  70.     kDBAboutToInit                = 1;
  71.     kDBInitComplete                = 2;
  72.     kDBSendComplete                = 3;
  73.     kDBExecComplete                = 4;
  74.     kDBStartQueryComplete        = 5;
  75.  
  76. { messages for status functions for DBGetQueryResults }
  77.     kDBGetItemComplete            = 6;
  78.     kDBGetQueryResultsComplete    = 7;
  79.     kDBWaitForever                = -1;
  80. {  flags for DBGetItem  }
  81.     kDBLastColFlag                = $0001;
  82.     kDBNullFlag                    = $0004;
  83.  
  84.     
  85. TYPE
  86.     DBType = OSType;
  87.  
  88.     DBAsyncParmBlkPtr = ^DBAsyncParamBlockRec;
  89.  
  90.     {
  91.         DBCompletionProcPtr uses register based parameters on the 68k and cannot
  92.         be written in or called from a high-level language without the help of
  93.         mixed mode or assembly glue.
  94.  
  95.         In:
  96.          => pb              A1.L
  97.     }
  98.     DBCompletionProcPtr = ProcPtr;  { PROCEDURE DBCompletion(pb: DBAsyncParmBlkPtr); }
  99.     DBCompletionUPP = UniversalProcPtr;
  100.  
  101.     DBAsyncParamBlockRec = RECORD
  102.         completionProc:            DBCompletionUPP;                        { pointer to completion routine }
  103.         result:                    OSErr;                                    { result of call }
  104.         userRef:                LONGINT;                                { for application's use }
  105.         ddevRef:                LONGINT;                                { for ddev's use }
  106.         reserved:                LONGINT;                                { for internal use }
  107.     END;
  108. CONST
  109.     uppDBCompletionProcInfo = $0000B802; { Register PROCEDURE (4 bytes in A1); }
  110.  
  111. PROCEDURE CallDBCompletionProc(pb: DBAsyncParmBlkPtr; userRoutine: DBCompletionUPP);
  112.     {$IFC NOT GENERATINGCFM}
  113.     {To be implemented:  Glue to move parameters into registers.}
  114.     {$ENDC}
  115.  
  116. FUNCTION NewDBCompletionProc(userRoutine: DBCompletionProcPtr): DBCompletionUPP;
  117.     {$IFC NOT GENERATINGCFM }
  118.     INLINE $2E9F;
  119.     {$ENDC}
  120.  
  121. TYPE
  122.     ResListElem = RECORD
  123.         theType:                ResType;                                { resource type }
  124.         id:                        INTEGER;                                { resource id }
  125.     END;
  126.     ResListPtr = ^ResListElem;
  127.     ResListHandle = ^ResListPtr;
  128.  
  129. { structure for query list in QueryRecord }
  130.     QueryArray = ARRAY [0..255] OF Handle;
  131.  
  132.     QueryListPtr = ^QueryArray;
  133.     QueryListHandle = ^QueryListPtr;
  134.  
  135.     QueryRecord = RECORD
  136.         version:                INTEGER;                                { version }
  137.         id:                        INTEGER;                                { id of 'qrsc' this came from }
  138.         queryProc:                Handle;                                    { handle to query def proc }
  139.         ddevName:                Str63;                                    { ddev name }
  140.         host:                    Str255;                                    { host name }
  141.         user:                    Str255;                                    { user name }
  142.         password:                Str255;                                    { password }
  143.         connStr:                Str255;                                    { connection string }
  144.         currQuery:                INTEGER;                                { index of current query }
  145.         numQueries:                INTEGER;                                { number of queries in list }
  146.         queryList:                QueryListHandle;                        { handle to array of handles to text }
  147.         numRes:                    INTEGER;                                { number of resources in list }
  148.         resList:                ResListHandle;                            { handle to array of resource list elements }
  149.         dataHandle:                Handle;                                    { for use by query def proc }
  150.         refCon:                    LONGINT;                                { for use by application }
  151.     END;
  152.     QueryPtr = ^QueryRecord;
  153.     QueryHandle = ^QueryPtr;
  154.  
  155. { structure of column types array in ResultsRecord }
  156.     ColTypesArray = ARRAY [0..255] OF DBType;
  157.  
  158.     ColTypesPtr = ^ColTypesArray;
  159.     ColTypesHandle = ^ColTypesPtr;
  160.  
  161.     DBColInfoRecord = RECORD
  162.         len:                    INTEGER;
  163.         places:                    INTEGER;
  164.         flags:                    INTEGER;
  165.     END;
  166.     ColInfoArray = ARRAY [0..255] OF DBColInfoRecord;
  167.  
  168.     ColInfoPtr = ^ColInfoArray;
  169.     ColInfoHandle = ^ColInfoPtr;
  170.  
  171.     ResultsRecord = RECORD
  172.         numRows:                INTEGER;                                { number of rows in result }
  173.         numCols:                INTEGER;                                { number of columns per row }
  174.         colTypes:                ColTypesHandle;                            { data type array }
  175.         colData:                Handle;                                    { actual results }
  176.         colInfo:                ColInfoHandle;                            { DBColInfoRecord array }
  177.     END;
  178.     DBQueryDefProcPtr = ProcPtr;  { FUNCTION DBQueryDef(VAR sessID: LONGINT; query: QueryHandle): OSErr; }
  179.     DBStatusProcPtr = ProcPtr;  { FUNCTION DBStatus(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr): BOOLEAN; }
  180.     DBResultHandlerProcPtr = ProcPtr;  { FUNCTION DBResultHandler(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle): OSErr; }
  181.     DBQueryDefUPP = UniversalProcPtr;
  182.     DBStatusUPP = UniversalProcPtr;
  183.     DBResultHandlerUPP = UniversalProcPtr;
  184.  
  185. CONST
  186.     uppDBQueryDefProcInfo = $000003E0; { FUNCTION (4 byte param, 4 byte param): 2 byte result; }
  187.     uppDBStatusProcInfo = $000FAA90; { FUNCTION (2 byte param, 2 byte param, 2 byte param, 2 byte param, 2 byte param, 4 byte param, 4 byte param): 1 byte result; }
  188.     uppDBResultHandlerProcInfo = $0003EAE0; { FUNCTION (4 byte param, 2 byte param, 2 byte param, 2 byte param, 4 byte param, 4 byte param): 2 byte result; }
  189.  
  190. FUNCTION NewDBQueryDefProc(userRoutine: DBQueryDefProcPtr): DBQueryDefUPP;
  191.     {$IFC NOT GENERATINGCFM }
  192.     INLINE $2E9F;
  193.     {$ENDC}
  194.  
  195. FUNCTION NewDBStatusProc(userRoutine: DBStatusProcPtr): DBStatusUPP;
  196.     {$IFC NOT GENERATINGCFM }
  197.     INLINE $2E9F;
  198.     {$ENDC}
  199.  
  200. FUNCTION NewDBResultHandlerProc(userRoutine: DBResultHandlerProcPtr): DBResultHandlerUPP;
  201.     {$IFC NOT GENERATINGCFM }
  202.     INLINE $2E9F;
  203.     {$ENDC}
  204.  
  205. FUNCTION CallDBQueryDefProc(VAR sessID: LONGINT; query: QueryHandle; userRoutine: DBQueryDefUPP): OSErr;
  206.     {$IFC NOT GENERATINGCFM}
  207.     INLINE $205F, $4E90;
  208.     {$ENDC}
  209.  
  210. FUNCTION CallDBStatusProc(message: INTEGER; result: OSErr; dataLen: INTEGER; dataPlaces: INTEGER; dataFlags: INTEGER; dataType: DBType; dataPtr: Ptr; userRoutine: DBStatusUPP): BOOLEAN;
  211.     {$IFC NOT GENERATINGCFM}
  212.     INLINE $205F, $4E90;
  213.     {$ENDC}
  214.  
  215. FUNCTION CallDBResultHandlerProc(dataType: DBType; theLen: INTEGER; thePlaces: INTEGER; theFlags: INTEGER; theData: Ptr; theText: Handle; userRoutine: DBResultHandlerUPP): OSErr;
  216.     {$IFC NOT GENERATINGCFM}
  217.     INLINE $205F, $4E90;
  218.     {$ENDC}
  219.  
  220. FUNCTION InitDBPack: OSErr;
  221.     {$IFC NOT GENERATINGCFM}
  222.     INLINE $3F3C, $0004, $303C, $0100, $A82F;
  223.     {$ENDC}
  224. FUNCTION DBInit(VAR sessID: LONGINT; ddevName: ConstStr63Param; host: ConstStr255Param; user: ConstStr255Param; passwd: ConstStr255Param; connStr: ConstStr255Param; asyncPB: DBAsyncParmBlkPtr): OSErr;
  225.     {$IFC NOT GENERATINGCFM}
  226.     INLINE $303C, $0E02, $A82F;
  227.     {$ENDC}
  228. FUNCTION DBEnd(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  229.     {$IFC NOT GENERATINGCFM}
  230.     INLINE $303C, $0403, $A82F;
  231.     {$ENDC}
  232. FUNCTION DBGetConnInfo(sessID: LONGINT; sessNum: INTEGER; VAR returnedID: LONGINT; VAR version: LONGINT; VAR ddevName: Str63; VAR host: Str255; VAR user: Str255; VAR network: Str255; VAR connStr: Str255; VAR start: LONGINT; VAR state: OSErr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  233.     {$IFC NOT GENERATINGCFM}
  234.     INLINE $303C, $1704, $A82F;
  235.     {$ENDC}
  236. FUNCTION DBGetSessionNum(sessID: LONGINT; VAR sessNum: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  237.     {$IFC NOT GENERATINGCFM}
  238.     INLINE $303C, $0605, $A82F;
  239.     {$ENDC}
  240. FUNCTION DBSend(sessID: LONGINT; text: Ptr; len: INTEGER; asyncPB: DBAsyncParmBlkPtr): OSErr;
  241.     {$IFC NOT GENERATINGCFM}
  242.     INLINE $303C, $0706, $A82F;
  243.     {$ENDC}
  244. FUNCTION DBSendItem(sessID: LONGINT; dataType: DBType; len: INTEGER; places: INTEGER; flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  245.     {$IFC NOT GENERATINGCFM}
  246.     INLINE $303C, $0B07, $A82F;
  247.     {$ENDC}
  248. FUNCTION DBExec(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  249.     {$IFC NOT GENERATINGCFM}
  250.     INLINE $303C, $0408, $A82F;
  251.     {$ENDC}
  252. FUNCTION DBState(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  253.     {$IFC NOT GENERATINGCFM}
  254.     INLINE $303C, $0409, $A82F;
  255.     {$ENDC}
  256. FUNCTION DBGetErr(sessID: LONGINT; VAR err1: LONGINT; VAR err2: LONGINT; VAR item1: Str255; VAR item2: Str255; VAR errorMsg: Str255; asyncPB: DBAsyncParmBlkPtr): OSErr;
  257.     {$IFC NOT GENERATINGCFM}
  258.     INLINE $303C, $0E0A, $A82F;
  259.     {$ENDC}
  260. FUNCTION DBBreak(sessID: LONGINT; abort: BOOLEAN; asyncPB: DBAsyncParmBlkPtr): OSErr;
  261.     {$IFC NOT GENERATINGCFM}
  262.     INLINE $303C, $050B, $A82F;
  263.     {$ENDC}
  264. FUNCTION DBGetItem(sessID: LONGINT; timeout: LONGINT; VAR dataType: DBType; VAR len: INTEGER; VAR places: INTEGER; VAR flags: INTEGER; buffer: UNIV Ptr; asyncPB: DBAsyncParmBlkPtr): OSErr;
  265.     {$IFC NOT GENERATINGCFM}
  266.     INLINE $303C, $100C, $A82F;
  267.     {$ENDC}
  268. FUNCTION DBUnGetItem(sessID: LONGINT; asyncPB: DBAsyncParmBlkPtr): OSErr;
  269.     {$IFC NOT GENERATINGCFM}
  270.     INLINE $303C, $040D, $A82F;
  271.     {$ENDC}
  272. FUNCTION DBKill(asyncPB: DBAsyncParmBlkPtr): OSErr;
  273.     {$IFC NOT GENERATINGCFM}
  274.     INLINE $303C, $020E, $A82F;
  275.     {$ENDC}
  276. FUNCTION DBGetNewQuery(queryID: INTEGER; VAR query: QueryHandle): OSErr;
  277.     {$IFC NOT GENERATINGCFM}
  278.     INLINE $303C, $030F, $A82F;
  279.     {$ENDC}
  280. FUNCTION DBDisposeQuery(query: QueryHandle): OSErr;
  281.     {$IFC NOT GENERATINGCFM}
  282.     INLINE $303C, $0210, $A82F;
  283.     {$ENDC}
  284. FUNCTION DBStartQuery(VAR sessID: LONGINT; query: QueryHandle; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  285.     {$IFC NOT GENERATINGCFM}
  286.     INLINE $303C, $0811, $A82F;
  287.     {$ENDC}
  288. FUNCTION DBGetQueryResults(sessID: LONGINT; VAR results: ResultsRecord; timeout: LONGINT; statusProc: DBStatusUPP; asyncPB: DBAsyncParmBlkPtr): OSErr;
  289.     {$IFC NOT GENERATINGCFM}
  290.     INLINE $303C, $0A12, $A82F;
  291.     {$ENDC}
  292. FUNCTION DBResultsToText(VAR results: ResultsRecord; VAR theText: Handle): OSErr;
  293.     {$IFC NOT GENERATINGCFM}
  294.     INLINE $303C, $0413, $A82F;
  295.     {$ENDC}
  296. FUNCTION DBInstallResultHandler(dataType: DBType; theHandler: DBResultHandlerUPP; isSysHandler: BOOLEAN): OSErr;
  297.     {$IFC NOT GENERATINGCFM}
  298.     INLINE $303C, $0514, $A82F;
  299.     {$ENDC}
  300. FUNCTION DBRemoveResultHandler(dataType: DBType): OSErr;
  301.     {$IFC NOT GENERATINGCFM}
  302.     INLINE $303C, $0215, $A82F;
  303.     {$ENDC}
  304. FUNCTION DBGetResultHandler(dataType: DBType; VAR theHandler: DBResultHandlerUPP; getSysHandler: BOOLEAN): OSErr;
  305.     {$IFC NOT GENERATINGCFM}
  306.     INLINE $303C, $0516, $A82F;
  307.     {$ENDC}
  308.  
  309. {$ALIGN RESET}
  310. {$POP}
  311.  
  312. {$SETC UsingIncludes := DatabaseAccessIncludes}
  313.  
  314. {$ENDC} {__DATABASEACCESS__}
  315.  
  316. {$IFC NOT UsingIncludes}
  317.  END.
  318. {$ENDC}
  319.