rmdir()--Remove Directory

 #include <unistd.h>

 int rmdir(const char *path);  

The rmdir() function removes a directory, path, provided that the directory is empty; that is, the directory contains no entries other than "dot" (.) or "dot-dot" (..). path must not end in dot (.) or dot-dot (..).

If no job currently has the directory open, rmdir() deletes the directory itself. The space occupied by the directory is freed for new use. If one or more jobs have the directory open, rmdir() removes the link and the dot (.) or dot-dot (..). entries. The directory itself is not removed until the last job closes the directory. New files cannot be created under a directory after the last link is removed, even if the directory is still open.

rmdir() does not remove a directory that still contains files or subdirectories. If path refers to a directory that is not empty, the [ENOTEMPTY] error is returned. If path refers to the current directory of the current job, to the "root" (/) directory, or to a directory that cannot be removed, the [EBUSY] error is returned.

If path refers to a symbolic link, rmdir() does not affect any file or directory named by the contents of the symbolic link.

If rmdir() is successful, the change and modification times for the parent directory are updated.

Parameters

path

(Input) A pointer to the null-terminated path name of the directory to be removed.

This parameter is assumed to be represented in the CCSID (coded character set identifier) currently in effect for the job. If the CCSID of the job is 65535, this parameter is assumed to be represented in the default CCSID of the job.

See QlgRmdir()--Remove Directory (using NLS-enabled path name) for a description and an example of supplying the path in any CCSID.

Authorities

Note: Adopted authority is not used.

Authorization Required for rmdir() (excluding QSYS.LIB, independent ASP QSYS.LIB, and QDLS)

Authorization Required for rmdir() in the QSYS.LIB and independent ASP QSYS.LIB File Systems

Authorization Required for rmdir() in the QDLS File System

Authorization Required for rmdir() in the QOPT File System

Return Value

0

rmdir() was successful.

-1

rmdir() was not successful. The errno global variable is set to indicate the error.

Error Conditions

If rmdir() is not successful, errno usually indicates one of the following errors. Under some conditions, errno could indicate an error other than those listed here.

If interaction with a file server is required to access the object, errno could indicate one of the following errors:

Error Messages

The following messages may be sent from this function:

Usage Notes

1. This function will fail with error code [ENOTSAFE] when all the following conditions are true:
   • Where multiple threads exist in the job.
     
   • The object on which this function is operating resides in a file system that is not threadsafe. Only the following file systems are threadsafe for this function:
     • "Root" (/)
     • QOpenSys
     • User-defined
     • QNTC
     • QSYS.LIB
     • Independent ASP QSYS.LIB
     • QOPT
     • Network File System
     • QFileSvr.400
   
   
2. QSYS.LIB and Independent ASP QSYS.LIB File System Differences

   If one or more jobs have the library or file open, rmdir() returns [EBUSY].

   If rmdir() is successful, the change and modification times for the parent library are updated only if the "directory" being removed is a database file.

   
   
3. QDLS File System Differences

   If one or more jobs have the folder open, or are using the folder as their current directory, rmdir() returns [EBUSY].

   
   
4. QOPT File System Differences

   The change and modification times of the parent directory are not updated.

   If path refers to a directory that any job has open, the [EBUSY] error is returned.

   
   
5. QNTC File System Differences

   The change and modification times of the parent directory are not updated.

Related Information

• The <unistd.h> file (see Header Files for UNIX^®-Type Functions)
  
• mkdir()--Make Directory
  
• QlgRmdir()--Remove Directory (using NLS-enabled path name)
  
• unlink()--Remove Link to File

Example

The following example removes a directory.

Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.

#include <sys/stat.h>
#include <unistd.h>
#include <stdio.h>
#include <sys/stat.h>
#include <fcntl.h>

main() {
  char new_dir[]="new_dir";
  char new_file[]="new_dir/new_file";
  int  file_descriptor;

  if (mkdir(new_dir, S_IRWXU|S_IRGRP|S_IXGRP) != 0)
    perror("mkdir() error");
  else if ((file_descriptor = creat(new_file, S_IWUSR)) < 0)
    perror("creat() error");
  else {
    close(file_descriptor);
    unlink(new_file);
  }

  if (rmdir(new_dir) != 0)
    perror("rmdir() error");
  else
    puts("removed!");
}

[ Back to top | UNIX-Type APIs | APIs by category ]