Contents

IORegistryEntryGetPath(_:_:_:)

Create a path for a registry entry.

Declaration

func IORegistryEntryGetPath(_ entry: io_registry_entry_t, _ plane: UnsafePointer<CChar>!, _ path: UnsafeMutablePointer<CChar>!) -> kern_return_t

Parameters

  • entry:

    The registry entry handle whose path to look up.

  • plane:

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

  • path:

    A char buffer allocated by the caller.

Return Value

IORegistryEntryGetPath will fail if the entry is not attached in the plane, or if the buffer is not large enough to contain the path.

Discussion

The path for a registry entry is copied to the caller's buffer. The path describes the entry's attachment in a particular plane, which must be specified. The path begins with the plane name followed by a colon, and then followed by '/' separated path components for each of the entries between the root and the registry entry. An alias may also exist for the entry, and will be returned if available.

See Also

Miscellaneous