Contents

IORegistryEntryGetLocationInPlane(_:_:_:)

Returns a C-string location assigned to a registry entry, in a specified plane.

Declaration

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

Parameters

  • entry:

    The registry entry handle whose name to look up.

  • plane:

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

  • location:

    The caller's buffer to receive the location string.

Return Value

A kern_return_t error code.

Discussion

Registry entries can given a location string in a particular plane, or globally. If the entry has had a location set in the specified plane that location string will be returned, otherwise the global location string is returned. If no global location string has been set, an error is returned.

See Also

Miscellaneous