en:docs:fapi:dosrmdir

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revisionBoth sides next revision
en:docs:fapi:dosrmdir [2018/08/29 12:42] – created prokusheven:docs:fapi:dosrmdir [2018/09/02 04:00] – prokushev
Line 1: Line 1:
 +{{logos:os2.gif?35x35}} {{logos:dos.gif?35x35}}
  
 +====== DosRmDir ======
  
 This call removes a subdirectory from the specified disk. This call removes a subdirectory from the specified disk.
  
 ==Syntax== ==Syntax==
- DosRmDir (DirName, Reserved)+ 
 +  DosRmDir (DirName, Reserved)
  
 ==Parameters== ==Parameters==
-;DirName (PSZ) - input : Address of the fully qualified path name of the subdirectory being removed. + 
-;Reserved (ULONG) - input : Reserved must be set to zero.+  *DirName (PSZ) - input : Address of the fully qualified path name of the subdirectory being removed. 
 +  *Reserved (ULONG) - input : Reserved must be set to zero.
  
 ==Return Code== ==Return Code==
- rc (USHORT) - return+ 
 +  rc (USHORT) - return 
 Return code descriptions are: Return code descriptions are:
-* 0        NO_ERROR  + 
-* 2        ERROR_FILE_NOT_FOUND  +  * 0        NO_ERROR  
-* 3        ERROR_PATH_NOT_FOUND  +  * 2        ERROR_FILE_NOT_FOUND  
-* 5        ERROR_ACCESS_DENIED  +  * 3        ERROR_PATH_NOT_FOUND  
-* 16       ERROR_CURRENT_DIRECTORY  +  * 5        ERROR_ACCESS_DENIED  
-* 26       ERROR_NOT_DOS_DISK  +  * 16       ERROR_CURRENT_DIRECTORY  
-* 87       ERROR_INVALID_PARAMETER  +  * 26       ERROR_NOT_DOS_DISK  
-* 108      ERROR_DRIVE_LOCKED  +  * 87       ERROR_INVALID_PARAMETER  
-* 206      ERROR_FILENAME_EXCED_RANGE+  * 108      ERROR_DRIVE_LOCKED  
 +  * 206      ERROR_FILENAME_EXCED_RANGE
  
 ==Remarks== ==Remarks==
 +
 The subdirectory must be empty, which means it cannot contain hidden files or directory entries other than the "." and ".." entries. Files can be deleted with [[DosDelete]]. The subdirectory must be empty, which means it cannot contain hidden files or directory entries other than the "." and ".." entries. Files can be deleted with [[DosDelete]].
  
Line 30: Line 38:
 ==Example Code== ==Example Code==
 === C Binding=== === C Binding===
-<PRE> 
-#define INCL_DOSFILEMGR 
  
-USHORT  rc = DosRmDir(DirName, Reserved); +  #define INCL_DOSFILEMGR 
- +   
-PSZ              DirName;       /* Directory name string */ +  USHORT  rc = DosRmDir(DirName, Reserved); 
-ULONG            0;             /* Reserved (must be zero) */ +   
- +  PSZ              DirName;       /* Directory name string */ 
-USHORT           rc;            /* return code */ +  ULONG            0;             /* Reserved (must be zero) */ 
-</PRE>+   
 +  USHORT           rc;            /* return code */
  
 ===MASM Binding=== ===MASM Binding===
-<PRE> 
-EXTRN  DosRmDir:FAR 
-INCL_DOSFILEMGR     EQU 1 
  
-PUSH@  ASCIIZ  DirName       ;Directory name string +  EXTRN  DosRmDir:FAR 
-PUSH   DWORD   0             ;Reserved (must be zero) +  INCL_DOSFILEMGR     EQU 1 
-CALL   DosRmDir+   
 +  PUSH@  ASCIIZ  DirName       ;Directory name string 
 +  PUSH   DWORD   0             ;Reserved (must be zero) 
 +  CALL   DosRmDir
  
 Returns WORD Returns WORD
-</PRE> 
- 
- 
  
 ====== Note ====== ====== Note ======