home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 15 / CDACTUAL15.iso / cdactual / program / pascal / FLASHPAC.ZIP / CH8_1.DOC < prev    next >
Encoding:
Text File  |  1991-03-15  |  17.6 KB  |  813 lines

  1. ..pgno01
  2. ..foot60A8-##
  3. ..head02L──────────────────────────────────────────────────────────────────────
  4. ..head04L──────────────────────────────────────────────────────────────────────
  5. ..head03AdChDir
  6. ■ Dos Versions        [2.0+]
  7.  
  8. ■ Source Module Name  d213B00d.asm
  9.  
  10. ■ Description
  11.  
  12.   Change to specified directory
  13.  
  14.  
  15. ■ Summary
  16.  
  17.   INT FPENTRY dChDir( CHAR *Path );
  18.  
  19.  
  20.   Parameter    Description
  21.   ─────────    ─────────────────────────────────────────────────
  22.   Path         path to change to
  23.  
  24.  
  25. ■ Function Return Value
  26.  
  27.   0 - function successfully changed path
  28. ..page
  29. ..head03AdCloseFile
  30. ■ Dos Versions        [2.0+]
  31.  
  32. ■ Source Module Name  d213E00d.asm
  33.  
  34. ■ Description
  35.  
  36.   Closes any file that was previously opened or created with a
  37.   call to dCreateFile or dOpenFile.
  38.  
  39.  
  40. ■ Summary
  41.  
  42.   INT FPENTRY dCloseFile( INT2 *Handle );
  43.  
  44.  
  45.   Parameter    Description
  46.   ─────────    ─────────────────────────────────────────────────
  47.   Handle       handle of the file to close
  48.  
  49.  
  50. ■ Function Return Value
  51.  
  52.   0 - function successfully closed file
  53. ..page
  54. ..head03AdCreateFile
  55. ■ Dos Versions        [2.0+]
  56.  
  57. ■ Source Module Name  d213C00d.asm
  58.  
  59. ■ Description
  60.  
  61.   Creates a new file in the specified or default directory on the
  62.   specified or default drive.  If the file already exists then
  63.   the file is truncated to length zero.
  64.  
  65.  
  66. ■ Summary
  67.  
  68.   INT FPENTRY dCreateFile( CHAR *Path, INT2 Attr, INT2 *Handle );
  69.  
  70.  
  71.   Parameter    Description
  72.   ─────────    ─────────────────────────────────────────────────
  73.   Path         path and filename of file to create
  74.   Attr         attribute to create file with
  75.   Handle       returns the handle of the file created
  76.  
  77.  
  78. ■ Function Return Value
  79.  
  80.   0 - function successfully changed path
  81. ..page
  82. ..head03AdCreateNewPsp
  83. ■ Dos Versions        [1.1+]
  84.  
  85. ■ Source Module Name  d212600d.asm
  86.  
  87. ■ Description
  88.  
  89.   Copies current programs psp to a specified segment address in
  90.   free memory before updating the psp to make it usable by
  91.   another program.
  92.  
  93.  
  94. ■ Summary
  95.  
  96.   VOID FPENTRY dCreateNewPsp( UINT2 Segment );
  97.  
  98.  
  99.   Parameter    Description
  100.   ─────────    ─────────────────────────────────────────────────
  101.   Segment      Segment of the new psp
  102.  
  103. ■ Function Return Value
  104.  
  105.   Nothing.
  106. ..page
  107. ..head03AdDelFile
  108. ■ Dos Versions        [2.0+]
  109.  
  110. ■ Source Module Name  d214100d.asm
  111.  
  112. ■ Description
  113.  
  114.   Delete specified file from the disk.
  115.  
  116.  
  117. ■ Summary
  118.  
  119.   INT FPENTRY dDelFile( CHAR *FileSpec );
  120.  
  121.   Parameter    Description
  122.   ─────────    ─────────────────────────────────────────────────
  123.   FileSpec     asciiz string containing the drive path and
  124.                filename of the file to be deleted.
  125.  
  126.  
  127. ■ Function Return Value
  128.  
  129.   0 - file deleted ok
  130.   1 - error trying to delete file
  131. ..page
  132. ..head03AdDiskReset
  133. ■ Dos Versions        [1.1+]
  134.  
  135. ■ Source Module Name  d210D00d.asm
  136.  
  137. ■ Description
  138.  
  139.   Flush all file buffers.  All data in the MS-DOS buffers are
  140.   physically written to the disk. The disk directory is NOT
  141.   updated.
  142.  
  143.  
  144. ■ Summary
  145.  
  146.   VOID FPENTRY dDiskReset( VOID );
  147.  
  148.  
  149. ■ Function Return Value
  150.  
  151.   Nothing
  152. ..page
  153. ..head03AdGetBreakStatus
  154. ■ Dos Versions        [2.0+]
  155.  
  156. ■ Source Module Name  d213300d.asm
  157.  
  158. ■ Description
  159.  
  160.   Get the status of the systems break flag that influences ctrl-c
  161.   checking.
  162.  
  163.  
  164. ■ Summary
  165.  
  166.   INT FPENTRY dGetBreakStatus( VOID );
  167.  
  168.  
  169. ■ Function Return Value
  170.   0 - Break flag is OFF
  171.   1 - Break flag is ON
  172. ..page
  173. ..head03AdGetBusyFlag
  174. ■ Dos Versions        [2.0+?]
  175.  
  176. ■ Source Module Name  d213400u.asm
  177.  
  178. ■ Description
  179.  
  180.   Get the address of the MS-DOS busy flag
  181.  
  182.  
  183. ■ Summary
  184.  
  185.   VOID FPENTRY dGetBusyFlag( UINT2 *dSeg, UINT2 *dOfs );
  186.  
  187.  
  188.   Parameter    Description
  189.   ─────────    ─────────────────────────────────────────────────
  190.   dSeg         returns the segment of the dos busy flag var
  191.   dOfs         returns the offset of the dos busy flag var
  192.  
  193.  
  194. ■ Function Return Value
  195.  
  196.   Segment:Offset address of the MS-DOS busy flag
  197. ..page
  198. ..head03AdGetCurrentDisk
  199. ■ Dos Versions        [1.1+]
  200.  
  201. ■ Source Module Name  d211900d.asm
  202.  
  203. ■ Description
  204.  
  205.   Get the number of the default disk drive.  (0=A, 1=B, etc).
  206.  
  207.  
  208. ■ Summary
  209.  
  210.   INT2 FPENTRY dGetCurrentDisk( VOID );
  211.  
  212.  
  213. ■ Function Return Value
  214.  
  215.   The drive code of the default disk drive.
  216. ..page
  217. ..head03AdGetDate
  218. ■ Dos Versions        [1.1+]
  219.  
  220. ■ Source Module Name  d212A00d.asm
  221.  
  222. ■ Description
  223.  
  224.   Use Dos to retrieve the system date
  225.  
  226.  
  227. ■ Summary
  228.  
  229.   VOID FPENTRY dGetDate( INT2 *Month, INT2 *Day, 
  230.                          INT2 *Year, INT2 *DayOfWk );
  231.  
  232.  
  233.   Parameter    Description
  234.   ─────────    ─────────────────────────────────────────────────
  235.   Month        returns the month of the year
  236.   Day          returns the day of the month
  237.   Year         returns the year (1980 thru 2099)
  238.   DayOfWk      returns the day of the week ( 0-6 ) where:
  239.                  0 -> Sunday
  240.                  6 -> Saturday
  241.  
  242.  
  243. ■ Function Return Value
  244.  
  245.   Nothing.
  246. ..page
  247. ..head03AdGetDriveData
  248. ■ Dos Versions        [2.0+]
  249.  
  250. ■ Source Module Name  d211C00d.asm
  251.  
  252. ■ Description
  253.  
  254.   Retrieve information about the default disk drive
  255.  
  256.  
  257. ■ Summary
  258.  
  259.   INT FPENTRY dGetDriveData( INT2   Drive,
  260.                              UINT2  *Sectors,
  261.                              UINT2  *MediaSeg,
  262.                              UINT2  *MediaOfs,
  263.                              UINT2  *SectorSize,
  264.                              UINT2  *Clusters  );
  265.  
  266.  
  267.   Parameter    Description
  268.   ─────────    ─────────────────────────────────────────────────
  269.   Drive        drive code of the drive to get the data on.
  270.                (0=default, 1=A, 2=B, etc.)
  271.   Sectors      Number of sectors per cluster
  272.   MediaSeg     Segment of the media id byte
  273.   MediaOfs     Offset of the media id byte
  274.   SectorSize   Number of bytes per sector
  275.   Clusters     Number of clusters on the drive
  276.  
  277.  
  278. ■ Function Return Value
  279.  
  280.   0 - unsuccessful (invalid drive, etc)
  281.   1 - successful
  282. ..page
  283. ..head03AdGetDrvAllocInfo
  284. ■ Dos Versions        [2.0+]
  285.  
  286. ■ Source Module Name  d213600d.asm
  287.  
  288. ■ Description
  289.  
  290.   Get information about a specified disk drive.
  291.  
  292.  
  293. ■ Summary
  294.  
  295.   INT FPENTRY dGetDrvAllocInfo( UINT  Drive,
  296.                                 UINT *Sectors,
  297.                                 UINT *AvailClusters,
  298.                                 UINT *BytesInSector,
  299.                                 UINT *TotalClusters );
  300.  
  301.  
  302.   Parameter      Description
  303.   ─────────     ─────────────────────────────────────────────────
  304.   Drive          disk drive code (0=default, 1=A, etc)
  305.   Sectors        number of sectors in a cluster
  306.   AvailClusters  number of available clusters
  307.   BytesInSector  number of bytes in a sector
  308.   TotalClusters  number of clusters in drive
  309.  
  310.  
  311. ■ Function Return Value
  312.  
  313.   0 - function unable to obtain information for drive
  314.   1 - function successfully obtained information
  315. ..page
  316. ..head03AdGetDta
  317. ■ Dos Versions        [2.0+]
  318.  
  319. ■ Source Module Name  d212F00d.asm
  320.  
  321. ■ Description
  322.  
  323.   Gets the current address of the disk transfer area being used
  324.   for file related functions.
  325.  
  326.  
  327. ■ Summary
  328.  
  329.   VOID FPENTRY dGetDta( UINT2 *Segment, UINT2 *Offset );
  330.  
  331.  
  332.   Parameter    Description
  333.   ─────────    ─────────────────────────────────────────────────
  334.   Segment      Segment of the DTA
  335.   Offset       Offset of the DTA
  336.  
  337.  
  338. ■ Function Return Value
  339.  
  340.   The segment and offset of the dta.
  341. ..page
  342. ..head03AdGetFileAttr
  343. ■ Dos Versions        [2.0+]
  344.  
  345. ■ Source Module Name  d214300d.asm
  346.  
  347. ■ Description
  348.  
  349.   Gets the attribute for the specified file.
  350.  
  351.  
  352. ■ Summary
  353.  
  354.   INT FPENTRY dGetFileAttr( CHAR *FileSpec, INT2 *Attr );
  355.  
  356.   Parameter    Description
  357.   ─────────    ─────────────────────────────────────────────────
  358.   FileSpec     handle of file to set file pointer
  359.   Attr         relative position to set location of pointer from
  360.  
  361.  
  362. ■ Function Return Value
  363.  
  364.   0 - file attribute obtained ok
  365.   1 - error trying to obtain files attribute
  366. ..page
  367. ..head03AdGetIntVec
  368. ■ Dos Versions        [2.0+]
  369.  
  370. ■ Source Module Name  d2135xxd.asm
  371.  
  372. ■ Description
  373.  
  374.   Get the address of the specified Interrupt
  375.  
  376.  
  377. ■ Summary
  378.  
  379.   VOID FPENTRY dGetIntVec( UINT2 dInt, UINT2 *dSeg, UINT2 *dOfs );
  380.  
  381.  
  382.   Parameter    Description
  383.   ─────────    ─────────────────────────────────────────────────
  384.   dInt         interrupt vector to retrieve
  385.   dSeg         returns the segment of the interrupt specified
  386.   dOfs         returns the offset of the interrupt specified
  387.  
  388. ■ Function Return Value
  389.  
  390.   Segment:Offset of specified interrupt
  391. ..page
  392. ..head03AdGetTime
  393. ■ Dos Versions        [1.1+]
  394.  
  395. ■ Source Module Name  dd212C00d.asm
  396.  
  397. ■ Description
  398.  
  399.   Use Dos to retrieve the system time
  400.  
  401.  
  402. ■ Summary
  403.  
  404.   VOID FPENTRY dGetTime( INT2 *Hour,    INT2 *Minute,
  405.                          INT2 *Seconds, INT2 *Hundredths );
  406.  
  407.  
  408.   Parameter    Description
  409.   ─────────    ─────────────────────────────────────────────────
  410.   Hour         returns the hour (0-23) on 24 hour clock
  411.   Minute       returns the minute (0-59)
  412.   Seconds      returns the seconds (0-59)
  413.   Hundredths   returns the hundredths of a second (0-99)
  414.  
  415.  
  416. ■ Function Return Value
  417.  
  418.   Nothing.
  419. ..page
  420. ..head03AdGetVersion
  421. ■ Dos Versions        [2.0+]
  422.  
  423. ■ Source Module Name  d213000d.asm
  424.  
  425. ■ Description
  426.  
  427.   Get the version number of the MS-DOS operating system.
  428.  
  429.  
  430. ■ Summary
  431.  
  432.   VOID FPENTRY dGetVersion( INT2 *Major, INT2 *Minor );
  433.  
  434.  
  435.   Parameter    Description
  436.   ─────────    ─────────────────────────────────────────────────
  437.   Major        Major version number
  438.   Minor        Minor version number
  439.  
  440. ■ Function Return Value
  441.  
  442.   Version number of operating system.
  443. ..page
  444. ..head03AdMkDir
  445. ■ Dos Versions        [2.0+]
  446.  
  447. ■ Source Module Name  d213900d.asm
  448.  
  449. ■ Description
  450.  
  451.   Create directory using specified path
  452.  
  453.  
  454. ■ Summary
  455.  
  456.   INT2 FPENTRY dMkDir( CHAR *Path );
  457.  
  458.  
  459.   Parameter    Description
  460.   ─────────    ─────────────────────────────────────────────────
  461.   Path         path to create
  462.  
  463.  
  464. ■ Function Return Value
  465.  
  466.   0 - function successfully created path
  467.   n - error code
  468. ..page
  469. ..head03AdOpenFile
  470. ■ Dos Versions        [2.0+]
  471.  
  472. ■ Source Module Name  d213D00d.asm
  473.  
  474. ■ Description
  475.  
  476.   Opens any existing file in the specified or default directory
  477.   on the specified or default drive.
  478.  
  479.  
  480. ■ Summary
  481.  
  482.   INT FPENTRY dOpenFile( CHAR *Path, INT2 Mode, INT2 *Handle );
  483.  
  484.  
  485.   Parameter    Description
  486.   ─────────    ─────────────────────────────────────────────────
  487.   Path         path and filename of file to create
  488.   Mode         attribute for the file
  489.   Handle       returns the handle of the file created
  490.  
  491.  
  492. ■ Function Return Value
  493.  
  494.   0 - function successfully changed path
  495. ..page
  496. ..head03AdReadFile
  497. ■ Dos Versions        [2.0+]
  498.  
  499. ■ Source Module Name  d213F00d.asm
  500.  
  501. ■ Description
  502.  
  503.   Read specified number of bytes from file into data buffer
  504.  
  505.  
  506. ■ Summary
  507.  
  508.   INT FPENTRY dReadFile( INT   Handle,  UINT2  NBytes,
  509.                          VOID *Buffer,  UINT2 *BytesRead );
  510.  
  511.  
  512.  
  513.   Parameter    Description
  514.   ─────────    ─────────────────────────────────────────────────
  515.   Handle       valid file handle of file to read from
  516.   NBytes       number of bytes to read
  517.   Buffer       data area to place data read from file
  518.   BytesRead    number of actual bytes read
  519.  
  520. ■ Function Return Value
  521.  
  522.   0 - file read performed ok
  523.   1 - error trying to read file
  524. ..page
  525. ..head03AdRmDir
  526. ■ Dos Versions        [2.0+]
  527.  
  528. ■ Source Module Name  d213A00d.asm
  529.  
  530. ■ Description
  531.  
  532.   Remove specified directory
  533.  
  534.  
  535. ■ Summary
  536.  
  537.   INT FPENTRY dRmDir( CHAR *Path );
  538.  
  539.  
  540.   Parameter    Description
  541.   ─────────    ─────────────────────────────────────────────────
  542.   Path         path to remove
  543.  
  544.  
  545. ■ Function Return Value
  546.  
  547.   0 - function successfully created path
  548.   n - error code
  549. ..page
  550. ..head03AdSelectDisk
  551. ■ Dos Versions        [1.1+]
  552.  
  553. ■ Source Module Name  d210E00d.asm
  554.  
  555. ■ Description
  556.  
  557.   Sets the specified drive to the default drive and returns the
  558.   number of logical drives in the system.
  559.  
  560.  
  561. ■ Summary
  562.  
  563.   INT2 FPENTRY dSelectDisk( INT2 Drive );
  564.  
  565.  
  566.   Parameter    Description
  567.   ─────────    ─────────────────────────────────────────────────
  568.   Drive        drive number (0=A, 1=B, etc )
  569.  
  570.  
  571. ■ Function Return Value
  572.  
  573.   The number of logical drives.
  574. ..page
  575. ..head03AdSetBreakFlag
  576. ■ Dos Versions        [2.0+]
  577.  
  578. ■ Source Module Name  d213301d.asm
  579.  
  580. ■ Description
  581.  
  582.   Sets the break flag to ON or OFF
  583.  
  584.  
  585. ■ Summary
  586.  
  587.   VOID FPENTRY dSetBreakFlag( INT flag );
  588.  
  589.  
  590.   Parameter    Description
  591.   ─────────    ─────────────────────────────────────────────────
  592.   flag         0 - to set break flag OFF
  593.                1 - to set break flag ON
  594.  
  595. ■ Function Return Value
  596.  
  597.   Nothing.
  598. ..page
  599. ..head03AdSetDate
  600. ■ Dos Versions        [1.1+]
  601.  
  602. ■ Source Module Name  d212B00d.asm
  603.  
  604. ■ Description
  605.  
  606.   Use Dos to set the system to a specified date
  607.  
  608.  
  609. ■ Summary
  610.  
  611.   INT FPENTRY dSetDate( INT Month, INT Day, INT Year );
  612.  
  613.   Parameter    Description
  614.   ─────────    ─────────────────────────────────────────────────
  615.   Month        month of year (1-12)
  616.   Day          day of month (1-31)
  617.   Year         year 1980-2099
  618.  
  619.  
  620. ■ Function Return Value
  621.  
  622.   0 - invalid date
  623.   1 - date set successfully
  624. ..page
  625. ..head03AdSetDta
  626. ■ Dos Versions        [1.1+]
  627.  
  628. ■ Source Module Name  d211A00d.asm
  629.  
  630. ■ Description
  631.  
  632.   Sets the address of the disk transfer area to be used for file
  633.   related functions.
  634.  
  635.  
  636. ■ Summary
  637.  
  638.   VOID FPENTRY dSetDta( UINT2 Segment, UINT2 Offset );
  639.  
  640.   Parameter    Description
  641.   ─────────    ─────────────────────────────────────────────────
  642.   Segment      Segment of the new DTA
  643.   Offset       Offset of the new DTA
  644.  
  645. ■ Function Return Value
  646.  
  647.   Nothing.
  648. ..page
  649. ..head03AdSetFileAttr
  650. ■ Dos Versions        [2.0+]
  651.  
  652. ■ Source Module Name  d214301d.asm
  653.  
  654. ■ Description
  655.  
  656.   Sets file position relative to beginning of file, current file
  657.   position, or end of file.
  658.  
  659.  
  660. ■ Summary
  661.  
  662.   INT FPENTRY dGetFileAttr( CHAR *FileSpec, INT2 *Attr );
  663.  
  664.   Parameter    Description
  665.   ─────────    ─────────────────────────────────────────────────
  666.   FileSpec     handle of file to set file pointer
  667.   Attr         relative position to set location of pointer from
  668.  
  669.  
  670. ■ Function Return Value
  671.  
  672.   0 - file attribute obtained ok
  673.   1 - error trying to obtain files attribute
  674. ..page
  675. ..head03AdSetFilePos
  676. ■ Dos Versions        [2.0+]
  677.  
  678. ■ Source Module Name  d214200d.asm
  679.  
  680. ■ Description
  681.  
  682.   Sets file position relative to beginning of file, current file
  683.   position, or end of file.
  684.  
  685.  
  686. ■ Summary
  687.  
  688.   INT FPENTRY dSetFilePos( INT2 Handle, INT Method, INT4 *Ofs );
  689.  
  690.   Parameter    Description
  691.   ─────────    ─────────────────────────────────────────────────
  692.   Handle       handle of file to set file pointer
  693.   Method       relative position to set location of pointer from
  694.   Ofs          number of bytes to move pointer.  returns the
  695.                absolute file position from the beginning of the
  696.                file.
  697.  
  698.  
  699. ■ Function Return Value
  700.  
  701.   0 - file pointer moved ok
  702.   1 - error trying to move file pointer
  703. ..page
  704. ..head03AdSetInt
  705. ■ Dos Versions        [1.1+]
  706.  
  707. ■ Source Module name  d2125xxd.asm
  708.  
  709. ■ Description
  710.  
  711.   Initialize the systems interrupt vector to point to a user
  712.   defined interrupt handling routine.
  713.  
  714.  
  715. ■ Summary
  716.  
  717.   VOID FPENTRY dSetInt( UINT2 Int, UINT2 Segment, UINT2 Offset );
  718.  
  719.  
  720.   Parameter    Description
  721.   ─────────    ─────────────────────────────────────────────────
  722.   Int          Interrupt number
  723.   Segment      Segment of the new interrupt routine
  724.   Offset       Offset of the new interrupt routine
  725.  
  726.  
  727. ■ Function Return Value
  728.  
  729.   Nothing.
  730. ..page
  731. ..head03AdSetTime
  732. ■ Dos Versions        [1.1+]
  733.  
  734. ■ Source Module Name  dd212D00d.asm
  735.  
  736. ■ Description
  737.  
  738.   Use Dos to set the system clock to a specified time
  739.  
  740.  
  741. ■ Summary
  742.  
  743.   VOID FPENTRY dSetTime( INT2 Hour,    INT2 Minute,
  744.                          INT2 Seconds, INT2 Hundredths );
  745.  
  746.  
  747.   Parameter    Description
  748.   ─────────    ─────────────────────────────────────────────────
  749.   Hour         the hour (0-23) on 24 hour clock
  750.   Minute       the minute (0-59)
  751.   Seconds      the seconds (0-59)
  752.   Hundredths   the hundredths of a second (0-99)
  753.  
  754.  
  755. ■ Function Return Value
  756.  
  757.   0 - invalid time
  758.   1 - time set successfully
  759. ..page
  760. ..head03AdSetVerityFlag
  761. ■ Dos Versions        [1.1+]
  762.  
  763. ■ Source Module Name  d212E00d.asm
  764.  
  765. ■ Description
  766.  
  767.   Turns the automatic read-after-write verification ON or OFF.
  768.  
  769.  
  770. ■ Summary
  771.  
  772.   VOID FPENTRY dSetVerifyFlag( INT2 VerifyOpt );
  773.  
  774.  
  775.   Parameter    Description
  776.   ─────────    ─────────────────────────────────────────────────
  777.   VerifyOpt    0 - Turn OFF verify flag
  778.                1 - Turn ON verify flag
  779.  
  780.  
  781. ■ Function Return Value
  782.  
  783.   Nothing.
  784. ..page
  785. ..head03AdWriteFile
  786. ■ Dos Versions        [2.0+]
  787.  
  788. ■ Source Module Name  d214000d.asm
  789.  
  790. ■ Description
  791.  
  792.   Write specified number of bytes to file from data buffer
  793.  
  794.  
  795. ■ Summary
  796.  
  797.   INT FPENTRY dWriteFile( INT   Handle,  UINT  NBytes,
  798.                           VOID *Buffer,  UINT *BytesWritten );
  799.  
  800.  
  801.   Parameter      Description
  802.   ─────────     ───────────────────────────────────────────────
  803.   Handle         valid file handle of file to write to
  804.   NBytes         number of bytes to write
  805.   Buffer         data area containing data to write
  806.   BytesWritten   number of actual bytes written
  807.  
  808. ■ Function Return Value
  809.  
  810.   0 - file write operation performed ok
  811.   1 - error trying to write file
  812. ..page
  813.