Mac Developer Library

Developer

IOConfigDirectory Class Reference

Options
Deployment Target:

On This Page
Language:

IOConfigDirectory

Inheritance


  • IOConfigDirectory

Conforms To


Not Applicable

Import Statement


Not Applicable

Objective-C

@import Kernel;

Availability


Available in OS X v10.0 and later.

  • Declaration

    C++

    virtual IOReturn getIndexEntry( intentry, 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.

  • Declaration

    C++

    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

  • Declaration

    C++

    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

  • Declaration

    C++

    virtual IOReturn getIndexValue( inttype, 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.

  • Declaration

    C++

    virtual IOReturn getKeySubdirectories( intkey, 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.

  • Declaration

    C++

    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

  • Declaration

    C++

    virtual IOReturn getKeyValue( intvalue, UInt32 &text, OSString **text = NULL);

    Parameters

    value

    on return, set to the data type

    reference to variable to store the entry's value

    text

    if non-zero, on return points to the string description of the field, or NULL if no text found.

    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.

  • Declaration

    C++

    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.

  • Declaration

    C++

    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.

Data Types

  • Declaration

    C++

    struct ExpansionData { };

    Discussion

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

Instance Variables

  • Reserved for future use. (Internal use only)

    Declaration

    C++

    ExpansionData *reserved;