lchown()--Change Owner and Group of Symbolic Link


  Syntax
 #include <unistd.h>

 int lchown(const char *path, uid_t owner, gid_t group);    
  Service Program Name: QP0LLIB1

  Default Public Authority: *USE

  Threadsafe: Conditional; see Usage Notes.

The lchown() function changes the owner and group of a file. If the named file is a symbolic link, lchown() changes the owner or group of the link itself rather than the object to which the link points. The permissions of the previous owner or primary group to the object are revoked.

If the file is checked out by another user (someone other than the user profile of the current job), lchown() fails with the [EBUSY] error.

When lchown() completes successfully, it updates the change time of the file.


Parameters

path
(Input) A pointer to the null-terminated path name of the file whose owner and group are being changed.

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 QlgLchown()--Change Owner and Group of Symbolic Link for a description and an example of supplying the path in any CCSID.


owner
(Input) The user ID (UID) of the new owner of the file. If the value is -1, the user ID is not changed.

group
(Input) The group ID (GID) of the new group for the file. If the value is -1, the group ID is not changed.

Note: Changing the owner or the primary group causes the S_ISUID (set-user-ID) and S_ISGID (set-group-ID) bits of the file mode to be cleared, unless the caller has *ALLOBJ special authority. If the caller does have *ALLOBJ special authority the bits are not changed. This does not apply to directories. See the chmod() documentation.


Authorities

Note: Adopted authority is not used.

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

Object Referred to Authority Required errno
Each directory in the path name preceding the object *X EACCES
Object, when changing the owner Owner and *OBJEXIST
(also see Note 1)
EPERM
Object, when changing the primary group See Note 2 EPERM
Previous owner's user profile, when changing the owner *DLT EPERM
New owner's user profile, when changing the owner *ADD EPERM
User profile of previous primary group, when changing the primary group *DLT EPERM
New primary group's user profile, when changing the primary group *ADD EPERM
Note:
  1. You do not need the listed authority if you have *ALLOBJ special authority.
  2. At least one of the following must be true:
    1. You have *ALLOBJ special authority.
    2. You are the owner and either of the following:
      • The new primary group is the primary group of the job.
      • The new primary group is one of the supplementary groups of the job.

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

Object Referred to Authority Required errno
Each directory in the path name preceding the object *X

See Note 1

EACCES
Object when changing the owner See Note 2(a) EPERM
Object when changing the primary group See Note 2(b) EPERM
Note:
  1. For *FILE objects (such as DDM file, diskette file, print file, and save file), *RX authority is required to the parent directory of the object, rather than just *X authority.
  2. The required authorization varies for each object type. For details of the following commands, see Security reference.
    1. CHGOWN
    2. CHGPGP

Authorization Required for lchown() in the QDLS File System

Object Referred to Authority Required errno
Each directory in the path name preceding the object *X EACCES
Object *ALLOBJ Special
Authority or Owner
EPERM
Previous owner's user profile, when changing the owner *DLT EPERM
New owner's user profile, when changing the owner *ADD EPERM
Previous primary group's user profile, when changing the primary group *DLT EPERM
New primary group's user profile, when changing the primary group *ADD EPERM

Authorization Required for lchown() in the QOPT File System

Object Referred to Authority Required errno
Volume authorization list *CHANGE EACCES
Each directory in the path name preceding the object. *X EACCES
Object *ALLOBJ Special
Authority or Owner
EPERM

Return Value

0
lchown() was successful.
-1
lchown() was not successful. The errno global variable is set to indicate the error.

Error Conditions

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

Error condition Additional information
[EACCES]

If you are accessing a remote file through the Network File System, update operations to file permissions at the server are not reflected at the client until updates to data that is stored locally by the Network File System take place. (Several options on the Add Mounted File System (ADDMFS) command determine the time between refresh operations of local data.) Access to a remote file may also fail due to different mappings of user IDs uid or group IDs (GID) on the local and remote systems.

[EAGAIN]  
[EBADFID]  
[EBADNAME]  
[EBUSY]  
[ECONVERT]  
[EDAMAGE]  
[EFAULT]  
[EFILECVT]  
[EINTR]  
[EINVAL]

For example, owner or group is not a valid user ID (UID) or group ID (GID).owner is the current primary group of the object.

[EIO]  
[EJRNDAMAGE]  
[EJRNENTTOOLONG]  
[EJRNINACTIVE]  
[EJRNRCVSPC]  
[ELOOP]  
[ENAMETOOLONG]  
[ENEWJRN]  
[ENEWJRNRCV]  
[ENOENT]  
[ENOSPC]  
[ENOTAVAIL]  
[ENOTDIR]  
[ENOTSAFE]  
[ENOTSUP]  
[EPERM]  
[EROOBJ]  
[ESTALE]

If you are accessing a remote file through the Network File System, the file may have been deleted at the server.

[EUNKNOWN]  


Error Messages

The following messages may be sent from this function:

Message ID Error Message Text
CPE3418 E Possible APAR condition or hardware failure.
CPFA0D4 E File system error occurred. Error number &1.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

Usage Notes

  1. This function will fail with error code [ENOTSAFE] when all the following conditions are true:


  2. QSYS.LIB and Independent ASP QSYS.LIB File System Differences

    lchown() is not supported for member (.MBR) objects.


  3. QDLS File System Differences

    The owner and primary group of the /QDLS directory (root folder) cannot be changed. If an attempt is made to change the owner and primary group, a [ENOTSUP] error is returned.


  4. QOPT File System Differences

    Changing the owner and primary group is allowed only for an object that exists on a volume formatted in Universal Disk Format (UDF). For all other media formats, ENOTSUP will be returned.

    QOPT file system objects that have owners will not be recognized by the Work with Objects by Owner (WRKOBJOWN) CL command. Likewise, QOPT objects that have a primary group will not be recognized by the Work Objects by Primary Group (WRKOBJPGP) CL command.


  5. QFileSvr.400 File System Differences

    The QFileSvr.400 file system does not support lchown().


  6. QNTC File System Differences

    The owner of files and directories cannot be changed. All files and directories in QNTC are owned by the QDFTOWN user profile.


Related Information


Example

The following example changes the owner and group of a file.

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

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

main() {
  char link_name[]="temp.link";
  char fn[]="temp.file";
  struct stat info;

  if (symlink(fn, link_name) == -1)
    perror("symlink() error");
  else {
    lstat(link_name, &info);
    printf("original owner was %d and group was %d\n", info.st_uid,
           info.st_gid);
    if (lchown(link_name, 152, 0) != 0)
      perror("lchown() error");
    else {
      lstat(link_name, &info);
      printf("after lchown(), owner is %d and group is %d\n",
             info.st_uid, info.st_gid);
    }
    unlink(link_name);
  }
}



API introduced: V3R1

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