en:docs:fapi:dosrmdir

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:docs:fapi:dosrmdir [2018/09/02 04:00] prokusheven:docs:fapi:dosrmdir [2021/09/17 08:17] (current) prokushev
Line 1: Line 1:
-{{logos:os2.gif?35x35}} {{logos:dos.gif?35x35}}+{{page>en:templates:fapiint}}
  
 ====== DosRmDir ====== ====== DosRmDir ======
Line 5: Line 5:
 This call removes a subdirectory from the specified disk. This call removes a subdirectory from the specified disk.
  
-==Syntax==+===== Syntax =====
  
-  DosRmDir (DirName, Reserved)+<code c> 
 +DosRmDir (DirName, Reserved) 
 +</code>
  
-==Parameters==+===== Parameters =====
  
-  *DirName (PSZ) - input : Address of the fully qualified path name of the subdirectory being removed. +  *DirName ([[PSZ]]) - input : Address of the fully qualified path name of the subdirectory being removed. 
-  *Reserved (ULONG) - input : Reserved must be set to zero.+  *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:
Line 30: Line 32:
   * 206      ERROR_FILENAME_EXCED_RANGE   * 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 36: Line 39:
 The root directory and current directory cannot be removed.  The root directory and current directory cannot be removed. 
  
-==Example Code== +===== Example Code ===== 
-=== C Binding===+ 
 +==== C Binding ===
 +<code c>
  
   #define INCL_DOSFILEMGR   #define INCL_DOSFILEMGR
Line 47: Line 52:
      
   USHORT           rc;            /* return code */   USHORT           rc;            /* return code */
 +</code>
  
-===MASM Binding===+==== MASM Binding ====
  
 +<code asm>
   EXTRN  DosRmDir:FAR   EXTRN  DosRmDir:FAR
   INCL_DOSFILEMGR     EQU 1   INCL_DOSFILEMGR     EQU 1
Line 56: Line 63:
   PUSH   DWORD               ;Reserved (must be zero)   PUSH   DWORD               ;Reserved (must be zero)
   CALL   DosRmDir   CALL   DosRmDir
 +</code>
  
 Returns WORD Returns WORD
  
-====== Note ======+===== Note =====
  
 Text based on http://www.edm2.com/index.php/DosRmDir Text based on http://www.edm2.com/index.php/DosRmDir