# class KACL

###

Module | kio
Namespace |
Class | KACL
Inherits |

The KACL class encapsulates a POSIX Access Control List. It follows the little standard that couldn't, 1003.1e/1003.2c, which died in draft status. a POSIX ACL encapsulation Author Till Adam <adam@kde.org>

### methods

- KACL (aclString)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  aclString | QString |

  Creates a new KACL from aclString. If the string is a valid acl string, isValid() will afterwards return true.

- KACL (rhs)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  rhs | KACL |

  Copy ctor

- KACL (basicPermissions)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  basicPermissions | mode_t |

  Creates a new KACL from the basic permissions passed in basicPermissions. isValid() will return true, afterwards.

- KACL ( )

  returns ctor

  Creates an empty KACL. Until a valid acl string is set via setACL, isValid() will return false.

- allGroupPermissions ( )

  returns ACLGroupPermissionsList

  Returns the list of all group permission entries. Each entry consists of a name/permissions pair. This is a QPair, therefor access is provided via the .first and .next members. Returns the list of all group permission entries.

- allUserPermissions ( )

  returns ACLUserPermissionsList

  Returns the list of all group permission entries. Each entry consists of a name/permissions pair. This is a QPair, therefore access is provided via the .first and .next members. Returns the list of all group permission entries.

- asString ( )

  returns QString

  Return a string representation of the ACL. Returns a string version of the ACL in the format compatible with libacl and POSIX 1003.1e. Implementations conforming to that standard should be able to take such strings as input.

- basePermissions ( )

  returns mode_t

  Returns the basic (owner/group/others) part of the ACL as a mode_t

- isExtended ( )

  returns bool

  Return whether the ACL contains extended entries or can be expressed using only basic file permissions. Returns whether the ACL contains extended entries

- isValid ( )

  returns bool

  Returns whether the KACL object represents a valid acl. Returns whether the KACL object represents a valid acl.

- maskPermissions ()

  returns unsigned short, bool (exists)

  Argument | Type | Default
  --- | --- | ---

  Return the entry for the permissions mask if there is one and sets exists to true. If there is no such entry, exists is set to false. Returns the permissions mask entry

- namedGroupPermissions (name)

  returns unsigned short, bool (exists)

  Argument | Type | Default
  --- | --- | ---
  name | QString |

  Access to the permissions entry for a named group, if such an entry exists. If exists is non-null, the boolean variable it points to is set to true if a matching entry exists and to false otherwise. Returns the permissions for a group with the name in name

- namedUserPermissions (name)

  returns unsigned short, bool (exists)

  Argument | Type | Default
  --- | --- | ---
  name | QString |

  Access to the permissions entry for a named user, if such an entry exists. If exists is non-null, the boolean variable it points to is set to true if a matching entry exists and to false otherwise. Returns the permissions for a user entry with the name in name

- operator != (rhs)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  rhs | KACL |

- operator == (rhs)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  rhs | KACL |

- othersPermissions ( )

  returns unsigned short

  Returns the premissions entry for others

- ownerPermissions ( )

  returns unsigned short

  Returns the owner's premissions entry

- owningGroupPermissions ( )

  returns unsigned short

  Returns the owning group's premissions entry

- setACL (aclStr)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  aclStr | QString |

  Sets the whole list from a string. If the string in aclStr represents a valid ACL, it will be set, otherwise the ACL remains unchanged. Returns whether setting the ACL was successful.

- setAllGroupPermissions (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | ACLGroupPermissionsList |

  Replace the list of all user permissions with list. If one of the entries in the list does not exists, or setting of the ACL entry fails for any reason, the ACL will be left unchanged. Returns success or failure

- setAllUserPermissions (list)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  list | ACLUserPermissionsList |

  Replace the list of all user permissions with list. If one of the entries in the list does not exists, or setting of the ACL entry fails for any reason, the ACL will be left unchanged. Returns success or failure

- setMaskPermissions (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | unsigned short |

  Set the permissions mask for the ACL. Permissions set for individual entries will be masked with this, such that their effective permissions are the result of the logical and of their entry and the mask. Returns success or failure

- setNamedGroupPermissions (name, a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  name | QString |
  a0 | unsigned short |

  Set the permissions for a group with the name name. Will fail if the group doesn't exist, in which case the ACL be unchanged. Returns success or failure.

- setNamedUserPermissions (name, a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  name | QString |
  a0 | unsigned short |

  Set the permissions for a user with the name name. Will fail if the user doesn't exist, in which case the ACL will be unchanged. Returns success or failure.

- setOthersPermissions (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | unsigned short |

  Set the permissions entry for others. Returns success or failure

- setOwnerPermissions (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | unsigned short |

  Set the owner's permissions entry. Returns success or failure

- setOwningGroupPermissions (a0)

  returns bool

  Argument | Type | Default
  --- | --- | ---
  a0 | unsigned short |

  Set the owning group's permissions entry. Returns success or failure

- virtual_hook (id, data)

  returns Nothing
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  id | int |
  data | void |