DosRmDir: Difference between revisions

Latest revision as of 06:36, 26 January 2020

This call removes a subdirectory from the specified disk.

Syntax

DosRmDir (DirName, Reserved)

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.

Return Code

rc (USHORT) - return: Return code descriptions are:

0 NO_ERROR
2 ERROR_FILE_NOT_FOUND
3 ERROR_PATH_NOT_FOUND
5 ERROR_ACCESS_DENIED
16 ERROR_CURRENT_DIRECTORY
26 ERROR_NOT_DOS_DISK
87 ERROR_INVALID_PARAMETER
108 ERROR_DRIVE_LOCKED
206 ERROR_FILENAME_EXCED_RANGE

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 root directory and current directory cannot be removed.

Bindings

C

#define INCL_DOSFILEMGR

USHORT  rc = DosRmDir(DirName, Reserved);

PSZ     DirName;       /* Directory name string */
ULONG   0;             /* Reserved (must be zero) */

USHORT  rc;            /* return code */

MASM

EXTRN  DosRmDir:FAR
INCL_DOSFILEMGR     EQU 1

PUSH@  ASCIIZ  DirName       ;Directory name string
PUSH   DWORD   0             ;Reserved (must be zero)
CALL   DosRmDir

Returns WORD

@@ Line 1: / Line 1: @@
-==Description==
 This call removes a subdirectory from the specified disk.
 ==Syntax==
-<PRE>
+  DosRmDir (DirName, Reserved)
-  DosRmDir
-    (DirName, Reserved)
-</PRE>
 ==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==
- rc (USHORT) - return
+;rc (USHORT) - return:Return code descriptions are:
+* 0 NO_ERROR
-Return code descriptions are:
+* 2 ERROR_FILE_NOT_FOUND
+* 3 ERROR_PATH_NOT_FOUND
-* 0        NO_ERROR
+* 5 ERROR_ACCESS_DENIED
-* 2        ERROR_FILE_NOT_FOUND
+* 16 ERROR_CURRENT_DIRECTORY
-* 3        ERROR_PATH_NOT_FOUND
+* 26 ERROR_NOT_DOS_DISK
-* 5        ERROR_ACCESS_DENIED
+* 87 ERROR_INVALID_PARAMETER
-* 16       ERROR_CURRENT_DIRECTORY
+*108 ERROR_DRIVE_LOCKED
-* 26       ERROR_NOT_DOS_DISK
+*206 ERROR_FILENAME_EXCED_RANGE
-* 87       ERROR_INVALID_PARAMETER
-* 108      ERROR_DRIVE_LOCKED
-* 206      ERROR_FILENAME_EXCED_RANGE
 ==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]].
 The root directory and current directory cannot be removed.
-==Example Code==
+==Bindings==
-=== C Binding===
+===C===
 <PRE>
 #define INCL_DOSFILEMGR
@@ Line 41: / Line 32: @@
 USHORT  rc = DosRmDir(DirName, Reserved);
-PSZ              DirName;       /* Directory name string */
+PSZ     DirName;       /* Directory name string */
-ULONG            0;             /* Reserved (must be zero) */
+ULONG   0;             /* Reserved (must be zero) */
-USHORT           rc;            /* return code */
+USHORT  rc;            /* return code */
 </PRE>
-===MASM Binding===
+===MASM===
 <PRE>
 EXTRN  DosRmDir:FAR
@@ Line 59: / Line 50: @@
 </PRE>
-==Related Functions==
+[[Category:Dos16]]
-*
-[[Category:The OS/2 API Project]]