Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

 ◄Key► ◄Summary►                             ◄Up► ◄Contents► ◄Index► ◄Back►
────────────────────────────────────────────────────────────────────────────
 
  Description:
 
     See ◄Introduction to heap routines►
 
  Parameters on Entry:
 
     None
 
  Parameters on Exit:
 
     heap-id                 This contains the heap handle assigned. A heap
                             handle of zero means the open failed.
 
     status-word             The status word for the heap, set to zero
                             on the open. When heap-id = 9, binary values
                             in the second status byte are:
 
                               000 =   heap closed by user request
                               001 =   heap access failure - out of buffers
                               002 =   heap deallocated while program
                                       inactive
                               014 =   backing-file failure: too many
                                       files
                               037 =   backing-file failure: file access
                                       denied
                               201 =   backing-file failure: I/O failure
 
                             status-word remains associated with the
                             heap until the heap is closed; the first byte
                             is set to ASCII zero by a successful OPEN;
                             status-word will be written as file status
                             data by a subsequent heap READ or WRITE or
                             CLOSE that encounters allocation or I/O errors
                             (but is not reset to zero by successful
                             operations).
 
                             If a program in which a heap status-word
                             actually exists (i.e. it is not in a Linkage
                             Section) is canceled, all heaps with status-
                             words in that program are automatically
                             canceled, and the heap identifiers (which may
                             have been passed to other programs) should not
                             be used any more.
                                    -♦-