Class IOKit.IORegistryEntry
- All Implemented Interfaces:
NativeMapped
- Direct Known Subclasses:
IOKit.IOService
- Enclosing interface:
- IOKit
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionConvenience method forIOKit.IORegistryEntryCreateCFProperties(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.ptr.PointerByReference, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF dictionary representation of this registry entry's property table.Convenience method forIOKit.IORegistryEntryCreateCFProperty(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF representation of this registry entry's property.getBooleanProperty(String key) Convenience method to get aBooleanvalue from this IO Registry Entry.byte[]Convenience method to get abytearray value from this IO Registry Entry.getChildEntry(String plane) Convenience method forIOKit.IORegistryEntryGetChildEntry(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return the first child of this registry entry in a plane.getChildIterator(String plane) Convenience method forIOKit.IORegistryEntryGetChildIterator(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return an iterator over this registry entry’s child entries in a plane.getDoubleProperty(String key) Convenience method to get aDoublevalue from this IO Registry Entry.getIntegerProperty(String key) Convenience method to get anIntegervalue from this IO Registry Entry.getLongProperty(String key) Convenience method to get aLongvalue from this IO Registry Entry.getName()Convenience method forIOKit.IORegistryEntryGetName(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.Pointer)to return a name assigned to this registry entry.getParentEntry(String plane) Convenience method forIOKit.IORegistryEntryGetParentEntry(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return the first parent of this registry entry in a plane.longConvenience method forIOKit.IORegistryEntryGetRegistryEntryID(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.ptr.LongByReference)to return an ID for this registry entry that is global to all tasks.getStringProperty(String key) Convenience method to get aStringvalue from this IO Registry Entry.(package private) CoreFoundation.CFTypeRefsearchCFProperty(String plane, CoreFoundation.CFStringRef key, int options) Convenience method forIOKit.IORegistryEntrySearchCFProperty(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF representation of a registry entry's property searched from this object.Methods inherited from class com.sun.jna.platform.mac.IOKit.IOObject
conformsTo, releaseMethods inherited from class com.sun.jna.PointerType
equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString
-
Constructor Details
-
IORegistryEntry
public IORegistryEntry() -
IORegistryEntry
-
-
Method Details
-
getRegistryEntryID
public long getRegistryEntryID()Convenience method forIOKit.IORegistryEntryGetRegistryEntryID(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.ptr.LongByReference)to return an ID for this registry entry that is global to all tasks.- Returns:
- the ID.
- Throws:
IOReturnException- if the ID could not be retrieved.
-
getName
Convenience method forIOKit.IORegistryEntryGetName(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.Pointer)to return a name assigned to this registry entry.- Returns:
- The name
- Throws:
IOReturnException- if the name could not be retrieved.
-
getChildIterator
Convenience method forIOKit.IORegistryEntryGetChildIterator(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return an iterator over this registry entry’s child entries in a plane.- Parameters:
plane- The name of an existing registry plane. Plane names are defined inIOKitKeys.h, for example,kIOServicePlane.- Returns:
- The iterator
- Throws:
IOReturnException- if the iterator could not be retrieved.
-
getChildEntry
Convenience method forIOKit.IORegistryEntryGetChildEntry(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return the first child of this registry entry in a plane.- Parameters:
plane- The name of an existing registry plane.- Returns:
- The child registry entry, if a child exists, null otherwise
- Throws:
IOReturnException- if the entry exists but could not be retrieved.
-
getParentEntry
Convenience method forIOKit.IORegistryEntryGetParentEntry(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.ptr.PointerByReference)to return the first parent of this registry entry in a plane.- Parameters:
plane- The name of an existing registry plane.- Returns:
- The parent registry entry, if a parent exists, null otherwise
- Throws:
IOReturnException- if the entry exists but could not be retrieved.
-
createCFProperty
Convenience method forIOKit.IORegistryEntryCreateCFProperty(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF representation of this registry entry's property.- Parameters:
key- ACFStringspecifying the property name.- Returns:
- A CF container is created and returned the caller on success.
The caller should release with
CoreFoundation.CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef).
-
createCFProperties
Convenience method forIOKit.IORegistryEntryCreateCFProperties(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.ptr.PointerByReference, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF dictionary representation of this registry entry's property table.- Returns:
- The property table.
The caller should release with
CoreFoundation.CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef). - Throws:
IOReturnException- if the entry could not be retrieved.
-
searchCFProperty
CoreFoundation.CFTypeRef searchCFProperty(String plane, CoreFoundation.CFStringRef key, int options) Convenience method forIOKit.IORegistryEntrySearchCFProperty(com.sun.jna.platform.mac.IOKit.IORegistryEntry, java.lang.String, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)to create a CF representation of a registry entry's property searched from this object.- Parameters:
plane- The name of an existing registry plane. Plane names are defined inIOKitKeys.h, for example,kIOServicePlane.key- ACFStringspecifying the property name.options-IOKit.kIORegistryIterateRecursivelymay be set to recurse automatically into the registry hierarchy. Without this option, this method degenerates into the standardIOKit.IORegistryEntryCreateCFProperty(com.sun.jna.platform.mac.IOKit.IORegistryEntry, com.sun.jna.platform.mac.CoreFoundation.CFStringRef, com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef, int)call.IOKit.kIORegistryIterateParentsmay be set to iterate the parents of the entry, in place of the children.- Returns:
- A CF container is created and returned the caller on success. The caller should release with CFRelease.
-
getStringProperty
Convenience method to get aStringvalue from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwise
-
getLongProperty
Convenience method to get aLongvalue from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwiseThis method assumes a 64-bit integer is stored and does not do type checking. If this object's type differs from the return type, and the conversion is lossy or the return value is out of range, then this method returns an approximate value.
-
getIntegerProperty
Convenience method to get anIntegervalue from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwiseThis method assumes a 32-bit integer is stored and does not do type checking. If this object's type differs from the return type, and the conversion is lossy or the return value is out of range, then this method returns an approximate value.
-
getDoubleProperty
Convenience method to get aDoublevalue from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwiseThis method assumes a floating point value is stored and does not do type checking. If this object's type differs from the return type, and the conversion is lossy or the return value is out of range, then this method returns an approximate value.
-
getBooleanProperty
Convenience method to get aBooleanvalue from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwise
-
getByteArrayProperty
Convenience method to get abytearray value from this IO Registry Entry.- Parameters:
key- The string name of the key to retrieve- Returns:
- The value of the registry entry if it exists;
nullotherwise
-