ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

IOConfigDirectory

Inherits from:	OSObject
Declared In:	IOConfigDirectory.h

Overview

Functions

getIndexEntry
getIndexKey
getIndexType
getIndexValue
getKeySubdirectories
getKeyType
getKeyValue
getSubdirectories
update

getIndexEntry

public

virtual IOReturn getIndexEntry(
    int index,
    UInt32 &value);

Parameters

entry: on return, set to the entry value
value: reference to variable to store the entry's value

Return Value

kIOReturnSuccess if the index exists in the dictionary

Discussion

Gets the entry at the specified index of the directory, as a raw UInt32.

getIndexKey

public

virtual IOReturn getIndexKey(
    int index,
    int &key);

Parameters

key: on return, set to the key

Return Value

kIOReturnSuccess if the index exists in the dictionary

Discussion

Gets the key for entry at the specified index

getIndexType

public

virtual IOReturn getIndexType(
    int index,
    IOConfigKeyType &type);

Parameters

type: on return, set to the data type

Return Value

kIOReturnSuccess if the index exists in the dictionary

Discussion

Gets the data type for entry at the specified index

getIndexValue

public

virtual IOReturn getIndexValue(
    int index,
    UInt32 &value);

Parameters

type: on return, set to the data type
value: reference to variable to store the entry's value

Return Value

kIOReturnSuccess if the index exists in the dictionary and is of a type appropriate for the value parameter

Discussion

Gets the value at the specified index of the directory, in a variety of forms.

getKeySubdirectories

public

virtual IOReturn getKeySubdirectories(
    int key,
    OSIterator *&iterator);

Parameters

key: type of subdirectory to iterate over
iterator: on return, set to point to an OSIterator

Return Value

kIOReturnSuccess if the iterator could be created

Discussion

Creates an iterator over subdirectories of a given type of the directory.

getKeyType

public

virtual IOReturn getKeyType(
    int key,
    IOConfigKeyType &type);

Parameters

type: on return, set to the data type

Return Value

kIOReturnSuccess if the key exists in the dictionary

Discussion

Gets the data type for the specified key

getKeyValue

public

virtual IOReturn getKeyValue(
    int key,
    UInt32 &value,
    OSString **text = NULL);

Parameters

value: on return, set to the data type
text: if non-zero, on return points to the string description of the field, or NULL if no text found.
value: reference to variable to store the entry's value

Return Value

kIOReturnSuccess if the key exists in the dictionary and is of a type appropriate for the value parameter

Discussion

Gets the value for the specified key, in a variety of forms.

getSubdirectories

public

virtual IOReturn getSubdirectories(
    OSIterator *&iterator);

Parameters

iterator: on return, set to point to an OSIterator

Return Value

kIOReturnSuccess if the iterator could be created

Discussion

Creates an iterator over the subdirectories of the directory.

update

public

virtual IOReturn update(
    UInt32 offset,
    const UInt32 *&romBase) = 0;

Return Value

kIOReturnSuccess if the specified offset is now accessable at romBase[offset].

Discussion

makes sure that the ROM has at least the specified capacity, and that the ROM is uptodate from its start to at least the specified quadlet offset.

Structs and Unions

ExpansionData

protected

struct ExpansionData {
};

Discussion

This structure will be used to expand the capablilties of the class in the future.

Member Data

reserved

protected

ExpansionData *reserved;

Discussion

Reserved for future use. (Internal use only)

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-12-19