DosRmDir

From EDM2
Jump to: navigation, search
Att.gif Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement: DosDeleteDir
Remarks: This function was renamed to DosDeleteDir on OS/2 2.0.

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.

Example Code

C Binding

#define INCL_DOSFILEMGR

USHORT  rc = DosRmDir(DirName, Reserved);

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

USHORT           rc;            /* return code */

MASM Binding

EXTRN  DosRmDir:FAR
INCL_DOSFILEMGR     EQU 1

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

Returns WORD

Related Functions