The maximum depth to which a permission (ACE) can be inherited. As the ACE gets inherited from a security parent, the value is decremented. Example values are as follows:
  • 0 - No inheritance (this object only).
  • 1 - This object and immediate children only.
  • -1 - This object and all children (infinite levels deep).
  • -2 - All children (infinite levels deep) but not this object.
  • -3 - Immediate children only; not this object.

A value of -2, -3, and less is only allowed on an ACE that is not inherited (that is, the PermissionSource value is SOURCE_DIRECT, SOURCE_DEFAULT, or SOURCE_TEMPLATE) and can be useful because that InheritableDepth value prevents the permission from affecting the security parent object itself. For instance, if the permission gave a user the DELETE right and the InheritableDepth value was -2, then the user would be able to delete security children objects that inherited that permission, but would not be able to delete the security parent object itself.

If the permission has been inherited (PermissionSource.SOURCE_PARENT), then the InheritableDepth value will always be 0, -1, 1, or other positive value greater than 1. The value will never be -2, -3, or other negative value less than -3.

For more information about inheritable depth values, see Security Inheritance.

Namespace:  FileNet.Api.Security
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Property InheritableDepth As Nullable(Of Integer)
C#
Nullable<int> InheritableDepth { get; set; }
Visual C++
property Nullable<int> InheritableDepth {
	Nullable<int> get ();
	void set (Nullable<int> value);
}
JavaScript
function get_inheritableDepth();
function set_inheritableDepth(value);

ToggleRemarks

ToggleSee Also