dos12.hlp (Table of Contents; Topic list)
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.
DosShutdown (1.2)
                                                      Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSFILEMGR
 
USHORT DosShutdown(ulReserved)
ULONG ulReserved;    /* must be zero */
 
The DosShutdown function flushes all system buffers and closes down the file
system. After DosShutdown is called, no process can access the file system
until the computer is rebooted.
 
Parameter   Description
────────────────────────────────────────────────────────────────────────────
 
ulReserved  Specifies a reserved value; must be zero.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be the following:
 
     ERROR_INVALID_PARAMETER
 
Comments
 
The DosShutdown function may take as much as several minutes to return,
depending on the amount of data being written to the disk.
 
Because it is not possible to swap memory to the disk once the DosShutdown
function has been called, some functions may fail due to a lack of memory in
low memory situations. All memory that the calling process may need should
be allocated before calling DosShutdown; this includes implicit memory
allocation that may be done by system functions for the calling process.
 
                                      ♦