Contents

IORegistryEntryCreateIterator(_:_:_:_:)

Create an iterator rooted at a given registry entry.

Declaration

func IORegistryEntryCreateIterator(_ entry: io_registry_entry_t, _ plane: UnsafePointer<CChar>!, _ options: IOOptionBits, _ iterator: UnsafeMutablePointer<io_iterator_t>!) -> kern_return_t

Parameters

  • entry:

    The root entry to begin the iteration at.

  • plane:

    The name of an existing registry plane. Plane names are defined in IOKitKeys.h, eg. kIOServicePlane.

  • options:

    kIORegistryIterateRecursively may be set to recurse automatically into each entry as it is returned from IOIteratorNext calls on the registry iterator. kIORegistryIterateParents may be set to iterate the parents of each entry, by default the children are iterated.

  • iterator:

    A created iterator handle, to be released by the caller when it has finished with it.

Return Value

A kern_return_t error code.

Discussion

This method creates an IORegistryIterator in the kernel that is set up with options to iterate children or parents of a root entry, and to recurse automatically into entries as they are returned, or only when instructed with calls to IORegistryIteratorEnterEntry. The iterator object keeps track of entries that have been recursed into previously to avoid loops.

See Also

Miscellaneous