IORegistryEntry
Базовый класс для всех объектов в реестре.
Базовый класс IORegistryEntry обеспечивает функции для описания графиков связанных ключей реестра, каждого с основанной на словаре таблицей свойства. Записи могут быть соединены в различных плоскостях с отличающейся топологией. Доступ к реестру защищен от многократных потоков. В ядре плоскости указаны с плоскими объектами и публикуются создателем - IOService экспортирует gIOServicePlane плоский объект, например. Не клиенты ядра указывают плоскости своим именем.
Наследование
Не применимый
Соответствует
Не применимый
Оператор импорта
Не применимый
Objective C
@import Kernel;
Доступность
Доступный в OS X v10.0 и позже.
-
Когда дочерний элемент присоединяет, метод вызвал в родительской записи.
Объявление
C++
virtual bool attachToChild( IORegistryEntry *
child
, const IORegistryPlane *plane
);Параметры
child
Присоединяемый ключ реестра.
plane
Плоский объект.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов, или если родитель совпадает с дочерним элементом.
Обсуждение
Когда дочерний элемент присоединяет, для создания переопределений возможными, этот метод вызывают в родительской записи. Этот метод также вызовет attachToParent в дочернем элементе, если это не вызовут от attachToParent. Если запись уже является дочерним элементом, это не и успех. Присоединение записи в реестр сохраняет обоих дочерний элемент и родитель, в то время как они присоединяются.
-
Присоединяет запись в родительскую запись в плоскости.
Объявление
C++
virtual bool attachToParent( IORegistryEntry *
parent
, const IORegistryPlane *plane
);Параметры
parent
Ключ реестра для присоединения к.
plane
Плоский объект.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов, или если родитель совпадает с дочерним элементом.
Обсуждение
Это - обычный метод ввода записи в реестр. Если запись уже присоединена к родителю, это не и успех. Присоединение записи в реестр сохраняет обоих дочерний элемент и родитель, в то время как они присоединяются. Этот метод вызовет attachToChild в родительской записи, если это не вызовут от attachToChild.
-
Ищет ключ реестра относительным путем.
Объявление
C++
virtual IORegistryEntry * childFromPath( const char *
path
, const IORegistryPlane *plane = 0, char *residualPath = 0, int *residualLength = 0 );Параметры
path
Посмотрите IORegistryEntry:: fromPath.
plane
Посмотрите IORegistryEntry:: fromPath.
residualPath
Посмотрите IORegistryEntry:: fromPath.
residualLength
Посмотрите IORegistryEntry:: fromPath.
Возвращаемое значение
Посмотрите IORegistryEntry:: fromPath.
Обсуждение
Эта функция ищет запись ниже вызванной записи относительным путем. Это - просто удобство, вызывающее IORegistryEntry:: fromPath с этим как fromEntry параметр.
-
Сравнивает имя записи с одним именем, и дополнительно возвращает соответствующее имя.
Объявление
C++
virtual bool compareName( OSString *
name
, OSString **matched = 0 ) const;Параметры
name
Имя для сравнения как OSString.
matched
Если вызывающая сторона хочет успешно соответствующее возвращенное имя, передайте ненулевой указатель для соответствующего параметра, и OSString будет возвращен сюда. Это должно быть выпущено вызывающей стороной. Если подстановочные знаки будут использоваться, Обычно это совпадет с параметром имени, но может не быть.
Возвращаемое значение
Истина, если имя сравнило истину с глобальным именем записи.
Обсуждение
Этот метод вызывают во время соответствия имени IOService и в другом месте от compareNames метода. Это должно быть переопределено для обеспечения нестандартного соответствия имени.
-
Сравнивает имя записи с одним или более именами, и дополнительно возвращает соответствующее имя.
Объявление
C++
virtual bool compareNames( OSObject *
name
, OSString **matched = 0 ) const;Параметры
name
Имя или имена для сравнения как любой OSCollection (например, OSArray, OSSet, OSDictionary) Осстрингса или единственного имени могут быть переданы OSString.
matched
Если вызывающая сторона хочет успешно соответствующее возвращенное имя, передайте ненулевой указатель для соответствующего параметра, и OSString будет возвращен сюда. Это должно быть выпущено вызывающей стороной.
Возвращаемое значение
Истина, если одно из имен сравнило истину с глобальным именем записи.
Обсуждение
Этот метод вызывают во время соответствия имени IOService и в другом месте сравнить глобальное имя записи со списком имен или единственного имени. В то время как единственное имя может быть передано OSString в параметре имени, список имен может быть передан как любой OSCollection Осстрингса. compareNames вызовет compareName метод для каждого имени для переопределений.
-
Возвращает первый дочерний элемент ключа реестра в плоскости. Доступный в Mac OS X 10.1 или позже.
Объявление
C++
virtual IORegistryEntry * copyChildEntry( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если запись не присоединяется в реестр в той плоскости, возвращает первый дочерний элемент ключа реестра или нуль. Ссылка на записи возвращается к вызывающей стороне, которая должна быть выпущена.
Обсуждение
Эта функция возвратит дочерний элемент, сначала присоединивший к ключу реестра.
-
Возвращает строку расположения, присвоенную ключу реестра как OSSymbol.
Объявление
C++
virtual const OSSymbol * copyLocation( const IORegistryPlane *plane = 0 ) const;
Параметры
plane
Плоский объект или нуль для глобального имени.
Возвращаемое значение
Ссылка на OSSymbol для расположения, если Вы существуете, который должен быть выпущен вызывающей стороной или нулем.
Обсуждение
Записи могут данный строку расположения в определенной плоскости, или глобально. Если записи установили расположение в плоскости, и плоскость указана, что строка расположения будет возвращена, иначе глобальная строка расположения возвращается. Если никакая глобальная строка расположения не была установлена, нуль возвращается.
-
Возвращает имя, присвоенное ключу реестра как OSSymbol.
Объявление
C++
virtual const OSSymbol * copyName( const IORegistryPlane *plane = 0 ) const;
Параметры
plane
Плоский объект или нуль для глобального имени.
Возвращаемое значение
Ссылка на OSSymbol для имени, которое должно быть выпущено вызывающей стороной.
Обсуждение
Записи можно назвать в определенной плоскости, или глобально. Если запись называют в плоскости, и плоскость указана, что имя будет возвращено, иначе глобальное имя возвращается. Глобальные значения по умолчанию имени к метаклассу записи называют, если это не назвали.
-
Возвращает первую родительскую запись ключа реестра в плоскости. Доступный в Mac OS X 10.1 или позже.
Объявление
C++
virtual IORegistryEntry * copyParentEntry( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если запись не присоединяется в реестр в той плоскости, возвращает первого родителя ключа реестра или нуль. Ссылка на записи возвращается к вызывающей стороне, которая должна быть выпущена.
Обсуждение
Эта функция возвратит родителя, к которому был сначала присоединен ключ реестра. Так как у большинства записей реестра есть только один провайдер, это - полезное упрощение.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * copyProperty( const char *
aKey
) const;Параметры
aKey
Имя свойства как струна до.
Возвращаемое значение
Значение свойства, найденное, или нуль. Это должно быть выпущено вызывающей стороной.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject и возврат ссылка на вызывающую сторону. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
copyProperty (символ константы *, константа IORegistryPlane *, IOOptionBits) - copyProperty (символ константы *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии. Доступный в Mac OS X 10.1 или позже.
Объявление
C++
virtual OSObject * copyProperty( const char *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как струна до.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль. Ссылка на любом найденном свойстве возвращается к вызывающей стороне, которая должна быть выпущена.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * copyProperty( const OSString *
aKey
) const;Параметры
aKey
Имя свойства как OSString.
Возвращаемое значение
Значение свойства, найденное, или нуль. Это должно быть выпущено вызывающей стороной.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject и возврат ссылка на вызывающую сторону. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
copyProperty (константа OSString *, константа IORegistryPlane *, IOOptionBits) - copyProperty (константа OSString *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии. Доступный в Mac OS X 10.1 или позже.
Объявление
C++
virtual OSObject * copyProperty( const OSString *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как OSString.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль. Ссылка на любом найденном свойстве возвращается к вызывающей стороне, которая должна быть выпущена.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * copyProperty( const OSSymbol *
aKey
) const;Параметры
aKey
Имя свойства как OSSymbol.
Возвращаемое значение
Значение свойства, найденное, или нуль. Это должно быть выпущено вызывающей стороной.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject и возврат ссылка на вызывающую сторону. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
copyProperty (константа OSSymbol *, константа IORegistryPlane *, IOOptionBits) - copyProperty (константа OSSymbol *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии. Доступный в Mac OS X 10.1 или позже.
Объявление
C++
virtual OSObject * copyProperty( const OSSymbol *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как OSSymbol.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль. Ссылка на любом найденном свойстве возвращается к вызывающей стороне, которая должна быть выпущена.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Полосы любые псевдонимы от главы пути и возвратов полный путь.
Объявление
C++
static const char * dealiasPath( const char **
opath
, const IORegistryPlane *plane
);Параметры
opath
В / paramter - вызывающая сторона передает в указателе на указатель струны до на путь. Если псевдоним найден, dealiasPath возвращает указатель в путь только вне конца псевдонима.
plane
Должен быть указан плоский объект.
Возвращаемое значение
Указатель струны до на значение псевдонима, если Вы найдены, или нуль если нет.
Обсуждение
Если указанный путь начинается с псевдонима, найденного в записи псевдонимов/, значение псевдонима возвращается, и указатель в переданный по пути после того, как псевдоним пасуется назад к вызывающей стороне. Если псевдоним не найден, нуль возвращается, и параметр пути неизменен.
-
Отсоединяет запись от всех ее родительских записей в плоскости.
Объявление
C++
virtual void detachAbove( const IORegistryPlane *
plane
);Параметры
plane
Плоский объект.
Обсуждение
Это вызовы метода detachFromParent в записи для каждой из ее родительских записей в плоскости.
-
Отсоединяет запись и все ее дочерние элементы рекурсивно в плоскости.
Объявление
C++
virtual void detachAll( const IORegistryPlane *
plane
);Параметры
plane
Плоский объект.
Обсуждение
Этот метод повреждает соединения реестра для поддерева. detachAbove вызывают в записи, и всех дочерних элементах и их дочерних элементах в плоскости.
-
Отсоединяет дочерний элемент от его родителя в плоскости.
Объявление
C++
virtual void detachFromChild( IORegistryEntry *
parent
, const IORegistryPlane *plane
);Параметры
parent
Ключ реестра для отсоединения.
plane
Плоский объект.
Обсуждение
Когда дочерний элемент отсоединяется, для создания переопределений возможными, этот метод вызывают в родительской записи. Если запись не является дочерним элементом родителя, это не. Отсоединение записи выпустит обоих дочерний элемент и родитель. Этот метод вызовет detachFromParent в дочернем элементе, если это не вызовут от detachFromParent.
-
Отсоединяет запись от родительской записи в плоскости.
Объявление
C++
virtual void detachFromParent( IORegistryEntry *
parent
, const IORegistryPlane *plane
);Параметры
parent
Ключ реестра для отсоединения от.
plane
Плоский объект.
Обсуждение
Это - обычный метод удаления записи из реестра. Если запись не присоединена к родителю, это не. Отсоединение записи выпустит обоих дочерний элемент и родитель. Этот метод вызовет detachFromChild в родительской записи, если это не вызовут от detachFromChild.
-
Синхронизированный метод получить копирует таблицу свойства ключа реестра.
Объявление
C++
virtual OSDictionary * dictionaryWithProperties(
void
) const;Возвращаемое значение
Создаваемый словарь или нуль на значении ресурса. Это должно быть выпущено вызывающей стороной.
Обсуждение
Этот метод скопирует таблицу свойства ключа реестра, с помощью OSDictionary:: семантика withDictionary. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Так как OSDictionary только скопирует значения свойств ссылкой, синхронизация не гарантируется никаким значениям набора.
-
Стандартный свободный метод для всех подклассов IORegistryEntry.
Объявление
C++
virtual void free(
void
);Обсуждение
Этот метод высвободит любые средства записи, в частности ее таблица свойства. Обратите внимание на то, что ключ реестра должен всегда отсоединяться из реестра, прежде чем свободный сможет быть вызван, и подклассы (а именно, IOService) будут иметь дополнительные протоколы для удаления ключей реестра. свободный никогда не должен должным быть быть вызванным непосредственно.
-
fromPath (символ константы *, константа IORegistryPlane *, символ *, интервал *) - fromPath (символ константы *, константа IORegistryPlane *, символ *, интервал *)
Ищет ключ реестра относительным путем.
Объявление
C++
virtual IORegistryEntry * childFromPath( const char *
path
, const IORegistryPlane *plane = 0, char *residualPath = 0, int *residualLength = 0 );Параметры
path
Посмотрите IORegistryEntry:: fromPath.
plane
Посмотрите IORegistryEntry:: fromPath.
residualPath
Посмотрите IORegistryEntry:: fromPath.
residualLength
Посмотрите IORegistryEntry:: fromPath.
Возвращаемое значение
Посмотрите IORegistryEntry:: fromPath.
Обсуждение
Эта функция ищет запись ниже вызванной записи относительным путем. Это - просто удобство, вызывающее IORegistryEntry:: fromPath с этим как fromEntry параметр.
-
fromPath (символ константы *, константа IORegistryPlane *, символ *, интервал *, IORegistryEntry *) - fromPath (символ константы *, константа IORegistryPlane *, символ *, интервал *, IORegistryEntry *)
Ищет ключ реестра путем.
Объявление
C++
static IORegistryEntry * fromPath( const char *
path
, const IORegistryPlane *plane = 0, char *residualPath = 0, int *residualLength = 0, IORegistryEntry *fromEntry = 0 );Параметры
path
Путь струны до.
plane
Плоскость к поиску путь или нуль, когда путь должен начаться с плоского имени.
residualPath
Если путь может содержать остаточные символы после того, как последний компонент контура, остаток будет скопирован назад в буфер residualPath вызывающей стороны. Если будут остаточные символы, и никакой остаточный буфер не указан, то fromPath перестанет работать.
residualLength
В / параметре - вызывающая сторона устанавливает длину остаточного доступного буфера, и fromPath возвращает общую длину остаточного пути, скопированного в буфер. Если нет никакого residualBuffer (residualPath = 0) тогда residualLength, может быть нуль также.
fromEntry
Поиск продолжится базированный при этой записи, если ненулевой, иначе это продолжается от корня плоскости.
Возвращаемое значение
Сохраненный ключ реестра возвращается на успехе или нуле при отказе. Вызывающая сторона должна выпустить запись.
Обсуждение
Эта функция анализирует пути к ключам реестра поиска. Путь может начаться <плоское имя>: создаваемый getPath или плоскостью может быть установлен вызывающей стороной. Если существуют символы, остающиеся непроанализированными после того, как запись искалась, это можно считать недопустимым поиском, или те символы могут пасоваться назад к вызывающей стороне и успешному поиску.
-
Возвращает первый дочерний элемент ключа реестра в плоскости.
Объявление
C++
virtual IORegistryEntry * getChildEntry( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если запись не присоединяется в реестр в той плоскости, возвращает первый дочерний элемент ключа реестра или нуль. В то время как запись присоединяется и не должна быть выпущена вызывающей стороной, дочерний элемент сохраняется.
Обсуждение
Эта функция возвратит дочерний элемент, сначала присоединивший к ключу реестра.
-
Возвращает итератор по дочерним элементам ключа реестра в плоскости.
Объявление
C++
virtual OSIterator * getChildIterator( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если существует отказ ресурсов, возвращает итератор по дочерним элементам записи или нуль. Когда итерация закончена, итератор должен быть выпущен. Все объекты, возвращенные итерацией, сохраняются, в то время как итератор допустим, хотя они больше не могут присоединяться во время итерации.
Обсуждение
Этот метод создает итератор, который возвратит каждые из дочерних элементов ключа реестра в указанной плоскости.
-
Считает максимальное количество записей между записью и корнем реестра, в плоскости.
Объявление
C++
virtual unsigned int getDepth( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Максимальное количество записей между записью и корнем. Если запись не присоединяется в плоскости, нуль возвращается.
Обсуждение
Этот метод считает число записей между и записи и корня реестра, в плоскости, для каждого родителя записи и возвращает максимальное значение.
-
Возвращает счет генерации для всех операций изменения реестра.
Объявление
C++
static SInt32 getGenerationCount(
void
);Возвращаемое значение
Целочисленное количество генерации.
Обсуждение
Этот метод обеспечивает средство доступа для текущего количества генерации (или семя) реестра, изменяющегося, когда любое изменение топологии происходит в реестре - это не включает табличные изменения свойства. Это может использоваться для лишения законной силы любого кэширования результатов методов IORegistryEntry.
-
Возвращает строку расположения, присвоенную ключу реестра как струна до.
Объявление
C++
virtual const char * getLocation( const IORegistryPlane *plane = 0 ) const;
Параметры
plane
Плоский объект или нуль для глобального имени.
Возвращаемое значение
Строка расположения струны до, допустимая, в то время как запись сохраняется, или нуль.
Обсуждение
Записи могут данный строку расположения в определенной плоскости, или глобально. Если записи установили расположение в плоскости, и плоскость указана, что строка расположения будет возвращена, иначе глобальная строка расположения возвращается. Если никакая глобальная строка расположения не была установлена, нуль возвращается.
-
Возвращает имя, присвоенное ключу реестра как струна до.
Объявление
C++
virtual const char * getName( const IORegistryPlane *plane = 0 ) const;
Параметры
plane
Плоский объект или нуль для глобального имени.
Возвращаемое значение
Имя струны до, допустимое, в то время как сохраняется запись.
Обсуждение
Записи можно назвать в определенной плоскости, или глобально. Если запись называют в плоскости, и плоскость указана, что имя будет возвращено, иначе глобальное имя возвращается. Глобальные значения по умолчанию имени к метаклассу записи называют, если это не назвали.
-
Возвращает первую родительскую запись ключа реестра в плоскости.
Объявление
C++
virtual IORegistryEntry * getParentEntry( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если запись не присоединяется в реестр в той плоскости, возвращает первого родителя ключа реестра или нуль. В то время как запись присоединяется и не должна быть выпущена вызывающей стороной, родитель сохраняется.
Обсуждение
Эта функция возвратит родителя, к которому был сначала присоединен ключ реестра. Так как у большинства записей реестра есть только один провайдер, это - полезное упрощение.
-
Возвращает итератор по родительским записям ключа реестра в указанной плоскости.
Объявление
C++
virtual OSIterator * getParentIterator( const IORegistryPlane *
plane
) const;Параметры
plane
Плоский объект.
Возвращаемое значение
Если существует отказ ресурсов, возвращает итератор по родителям ключа реестра или нуль. Когда итерация закончена, итератор должен быть выпущен. Все объекты, возвращенные итерацией, сохраняются, в то время как итератор допустим, хотя они больше не могут присоединяться во время итерации.
-
Создайте путь для ключа реестра.
Объявление
C++
virtual bool getPath( char *
path
, int *length
, const IORegistryPlane *plane
) const;Параметры
path
Символьный буфер выделяется вызывающей стороной.
length
В / параметре - вызывающая сторона устанавливает длину доступного буфера, и getPath возвращает общую длину пути, скопированного в буфер.
plane
Плоский объект.
Возвращаемое значение
getPath перестанет работать, если запись не будет присоединена в плоскости, или если буфер не является достаточно большим для содержания пути.
Обсуждение
Путь для ключа реестра копируется в буфер вызывающей стороны. Путь описывает присоединение записи в определенной плоскости, которая должна быть указана. Путь начинается с плоского имени, сопровождаемого двоеточием, и затем сопровождаемого '/' разделенные компоненты контура для каждой из записей между корнем и ключом реестра. Каждый компонент создается с getPathComponent методом, вызванным в каждой записи. Псевдоним может также существовать для записи, которые описаны как свойства в ключе реестра, найденном в псевдонимах / в плоскости. Если значение свойства, интерпретируемое как путь в вызове к IORegistryEntry:: fromPath приводит к записи, тогда имя свойства используется в качестве пути записи.
-
Создайте компонент контура для ключа реестра.
Объявление
C++
virtual bool getPathComponent( char *
path
, int *length
, const IORegistryPlane *plane
) const;Параметры
path
Символьный буфер выделяется вызывающей стороной.
length
В / параметре - вызывающая сторона устанавливает длину доступного буфера, и getPathComponent возвращает общую длину компонента контура, скопированного в буфер.
plane
Плоский объект.
Возвращаемое значение
истина, если путь вписывается в предоставленный буфер или ложь на переполнении.
Обсуждение
Каждый компонент пути, создаваемого с getPath, создается с getPathComponent. Реализация по умолчанию связывает имя записи в плоскость, с «в» символе и строке расположения записи в плоскости, если это было установлено.
-
Ищет плоский объект именем струны до.
Объявление
C++
static const IORegistryPlane * getPlane( const char *
name
);Возвращаемое значение
Указатель на плоский объект или нуль, если не существует никакая такая плоскость. Возвращенная плоскость не должна быть выпущена.
Обсуждение
Плоскости обычно предоставлены как глобальные переменные создателем, например, gIOServicePlane, gIODeviceTreePlane, или gIOAudioPlane, однако они могут также искаться по имени с этим методом.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * getProperty( const char *
aKey
) const;Параметры
aKey
Имя свойства как струна до.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
getProperty (символ константы *, константа IORegistryPlane *, IOOptionBits) - getProperty (символ константы *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии.
Объявление
C++
virtual OSObject * getProperty( const char *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как струна до.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * getProperty( const OSString *
aKey
) const;Параметры
aKey
Имя свойства как OSString.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
getProperty (константа OSString *, константа IORegistryPlane *, IOOptionBits) - getProperty (константа OSString *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии.
Объявление
C++
virtual OSObject * getProperty( const OSString *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как OSString.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Синхронизированный метод получить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual OSObject * getProperty( const OSSymbol *
aKey
) const;Параметры
aKey
Имя свойства как OSSymbol.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет поиск свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика getObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
getProperty (константа OSSymbol *, константа IORegistryPlane *, IOOptionBits) - getProperty (константа OSSymbol *, константа IORegistryPlane *, IOOptionBits)
Синхронизированный метод получить свойство из ключа реестра или одного из его родителей (или дочерние элементы) в иерархии.
Объявление
C++
virtual OSObject * getProperty( const OSSymbol *
aKey
, const IORegistryPlane *plane
, IOOptionBits options = kIORegistryIterateRecursively |options
) const;Параметры
aKey
Имя свойства как OSSymbol.
plane
Плоскость для итерации, например, gIOServicePlane.
options
kIORegistryIterateRecursively может быть установлен рекурсивно вызвать автоматически в иерархию реестра. Без этой опции этот метод ухудшается в стандарт getProperty () вызов. kIORegistryIterateParents может быть установлен выполнить итерации родителей записи вместо дочерних элементов.
Возвращаемое значение
Значение свойства, найденное, или нуль.
Обсуждение
Этот метод будет искать свойство, запускаясь сначала с таблицы свойства этого ключа реестра, затем выполняя итерации рекурсивно или через родительские ключи реестра или через дочерние ключи реестра этой записи. Как только первое возникновение найдено, оно будет поиск и возвращать значение свойства, с помощью OSDictionary:: семантика getObject. Итерация отслеживает записи, рекурсивно вызванные в ранее для предотвращения циклов. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице (ам) свойства.
-
Несинхронизируемое средство доступа к таблице свойства ключа реестра.
Объявление
C++
OSDictionary * getPropertyTable(
void
) const;Возвращаемое значение
Указатель на таблицу свойства как OSDictionary. В то время как ключ реестра сохраняется и не должен быть выпущен вызывающей стороной, указатель допустим.
Обсуждение
Этот метод возвратит указатель на живую таблицу свойства как OSDictionery. Его использование не рекомендуется в большинстве случаев, вместо этого используйте синхронизируемые средства доступа и функции помощника IORegistryEntry для доступа к свойствам. Это может только безопасно использоваться одним потоком, обычно означающим, что это может только использоваться, прежде чем ключ реестра вводится в реестр.
-
Возвращает ID для ключа реестра, который является глобальной переменной ко всем задачам.
Объявление
C++
uint64_t getRegistryEntryID(
void
);Возвращаемое значение
ID для ключа реестра, присвоенного, когда запись сначала присоединяется в реестре.
Обсуждение
Запись ID, возвращенный getRegistryEntryID, может использоваться для идентификации ключа реестра через все задачи. Ключ реестра может искаться его записью ID путем создания соответствующего словаря с IORegistryEntryIDMatching () в пространстве пользователя, или
IOService::registryEntryIDMatching()
в ядре, чтобы использоваться с IOKit соответствие функций. ID допустим только до перезагрузок машины. -
Возвращает указатель на корневой экземпляр реестра.
Объявление
C++
static IORegistryEntry * getRegistryRoot(
void
);Возвращаемое значение
Указатель на корневой экземпляр IORegistryEntry. Это не должно быть выпущено вызывающей стороной.
Обсуждение
Этот метод обеспечивает средство доступа для корня реестра для машины. Корень может быть передан итератору реестра при итерации плоскости и содержит свойства, описывающие доступные плоскости и диагностическую информацию для IOKit. Ключи для этих свойств находятся в IOKitKeys.h.
-
Стандарт init метод для всех подклассов IORegistryEntry.
Объявление
C++
virtual bool init( OSDictionary *dictionary = 0 );
Параметры
A
словарь, который станет таблицей свойства ключа реестра (сохраняющий его), или нуль, который заставит пустую таблицу свойства создаваться.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Ключ реестра должен быть инициализирован с этим методом, прежде чем это сможет использоваться. Словарь свойства может, передал и будет сохранен этим методом для использования в качестве таблицы свойства ключа реестра, или будет создаваться пустой.
-
Определяет, присоединяется ли ключ реестра в плоскости.
Объявление
C++
virtual bool inPlane( const IORegistryPlane *plane = 0) const;
Параметры
plane
Плоский объект, 0 указывает любую плоскость.
Возвращаемое значение
Если запись имеет родителя в данной плоскости или если плоскость = 0 тогда, если запись имеет любого родителя; возвратите true, иначе ложь.
Обсуждение
Этот метод определяет, присоединяется ли запись в плоскости к какой-либо другой записи. Это может также использоваться, чтобы определить, является ли запись элементом какой-либо плоскости.
-
Определяет, является ли ключ реестра дочерним элементом другого в плоскости.
Объявление
C++
virtual bool isChild( IORegistryEntry *
child
, const IORegistryPlane *plane
, bool onlyChild = false ) const;Параметры
child
Возможный дочерний ключ реестра.
plane
Плоский объект.
onlyChild
Если это правда, проверьте также, если дочерний элемент является единственным дочерним элементом.
Возвращаемое значение
Если дочерним параметром не является дочерний элемент ключа реестра, false возвращается. Если onlyChild является истиной, и дочерний элемент не является единственным дочерним элементом записи, false возвращается, иначе true возвращается.
Обсуждение
Этот метод, вызванный в родительской записи, определяет, является ли указанная запись дочерним элементом в плоскости. Кроме того, это может проверить, является ли дочерний элемент единственным дочерним элементом родительской записи.
-
Определяет, является ли ключ реестра родителем другого в плоскости.
Объявление
C++
virtual bool isParent( IORegistryEntry *
parent
, const IORegistryPlane *plane
, bool onlyParent = false ) const;Параметры
parent
Возможный родительский ключ реестра.
plane
Плоский объект.
onlyParent
Если это правда, проверьте также, если родитель является единственным родителем.
Возвращаемое значение
Если родительским параметром не является родитель ключа реестра, false возвращается. Если onlyParent является истиной, и родитель не является единственным родителем записи, false возвращается, иначе true возвращается.
Обсуждение
Этот метод, вызванный в дочернем элементе, определяет, является ли указанная запись родителем в плоскости. Кроме того, это может проверить, является ли родитель единственным родителем дочернего элемента.
-
Создает объект IORegistryPlane.
Объявление
C++
static const IORegistryPlane * makePlane( const char *
name
);Параметры
name
Имя струны до для новой плоскости, чтобы быть скопированным.
Возвращаемое значение
Новый экземпляр IORegistryPlane или нуль при отказе.
Обсуждение
Большинство плоскостей в IOKit создается OS, несмотря на то, что могут быть созданы другие плоскости.
-
Синхронизированный метод удалить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual void removeProperty( const char *
aKey
);Параметры
aKey
Имя свойства как струна до.
Обсуждение
Этот метод удалит свойство из таблицы свойства ключа реестра, с помощью OSDictionary:: семантика removeObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
Синхронизированный метод удалить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual void removeProperty( const OSString *
aKey
);Параметры
aKey
Имя свойства как OSString.
Обсуждение
Этот метод удалит свойство из таблицы свойства ключа реестра, с помощью OSDictionary:: семантика removeObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
Синхронизированный метод удалить свойство из таблицы свойства ключа реестра.
Объявление
C++
virtual void removeProperty( const OSSymbol *
aKey
);Параметры
aKey
Имя свойства как OSSymbol.
Обсуждение
Этот метод удалит свойство из таблицы свойства ключа реестра, с помощью OSDictionary:: семантика removeObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
Единственный поток вызов к действию w.r.t. блокировка свойства
Объявление
C++
virtual IOReturn runPropertyAction( Action
action
, OSObject *target
, void *arg0 = 0, void *arg1 = 0, void *arg2 = 0, void *arg3 = 0);Параметры
action
Указатель для функционирования, чтобы быть выполненным в контексте цикла работы.
arg0
Параметр для параметра действия, значений по умолчанию к 0.
arg1
Параметр для параметра действия, значений по умолчанию к 0.
arg2
Параметр для параметра действия, значений по умолчанию к 0.
arg3
Параметр для параметра действия, значений по умолчанию к 0.
Возвращаемое значение
Возвращает значение выноски Действия.
Обсуждение
Клиентская функция, заставляющая данное действие быть вызванным способом что syncrhonises с итераторами реестра и сериализаторами. Этот functin может использоваться для синхронного управления таблицей свойства этого куска
-
Синхронизированный метод сериализировать таблицу свойства ключа реестра.
Объявление
C++
virtual bool serializeProperties( OSSerialize *
serialize
) const;Параметры
serialize
Экземпляр OSSerialize, представляющий запрос сериализации.
Возвращаемое значение
Истина на успехе, ложь иначе.
Обсуждение
Этот метод сериализирует таблицу свойства ключа реестра, с помощью OSDictionary:: сериализируйте семантику. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Много клиентов неядра IOKit считывают информации из реестра через свойства и вызовут этот метод в ключе реестра для создания сериализации свойств всей записи, тогда восстановленной в задаче клиента как CFDictionary. Этот метод может быть прерван подклассами, чтобы обновить их свойства или реализовать различный метод сериализации, хотя обычно лучше реализовать такую функциональность путем создания объектов в таблице свойства и реализации их сериализировать методы, предотвращения любой потребности реализовать serializeProperties.
-
Устанавливает строку расположения для ключа реестра, в определенной плоскости, или глобально.
Объявление
C++
virtual void setLocation( const OSSymbol *
location
, const IORegistryPlane *plane = 0 );Параметры
location
Строка расположения струны до, которая будет скопирована, или OSSymbol, который будет сохранен.
plane
Плоский объект или нуль для установки глобальной строки расположения.
Обсуждение
Записям можно дать строку расположения в определенной плоскости, или глобально. Если плоскость указана, расположение применяется только к той плоскости, иначе глобальное расположение установлено. Строка расположения может использоваться во время поисков пути ключей реестра, для различения одноуровневые записи с тем же именем. Парсинг IORegistryEntry по умолчанию строк расположения ожидает список шестнадцатеричных чисел, разделенных запятыми, хотя подклассы IORegistryEntry могли бы сделать свой собственный парсинг.
-
setName (символ константы *, константа IORegistryPlane *) - setName (символ константы *, константа IORegistryPlane *)
Определяет имя для ключа реестра, в определенной плоскости, или глобально.
Объявление
C++
virtual void setName( const char *
name
, const IORegistryPlane *plane = 0 );Параметры
name
Имя струны до константы, которое будет скопировано.
plane
Плоский объект или нуль для определения глобального имени.
Обсуждение
Записи можно назвать в определенной плоскости, или глобально. Если плоскость указана, имя применяется только к той плоскости, иначе глобальное имя определяется. Глобальные значения по умолчанию имени к метаклассу записи называют, если это не назвали.
-
setName (константа OSSymbol *, константа IORegistryPlane *) - setName (константа OSSymbol *, константа IORegistryPlane *)
Определяет имя для ключа реестра, в определенной плоскости, или глобально.
Объявление
C++
virtual void setName( const OSSymbol *
name
, const IORegistryPlane *plane = 0 );Параметры
name
OSSymbol, который будет сохранен.
plane
Плоский объект или нуль для определения глобального имени.
Обсуждение
Записи можно назвать в определенной плоскости, или глобально. Если плоскость указана, имя применяется только к той плоскости, иначе глобальное имя определяется. Глобальные значения по умолчанию имени к метаклассу записи называют, если это не назвали.
-
Дополнительно поддерживаемый внешний метод для установки свойств в ключе реестра.
Объявление
C++
virtual IOReturn setProperties( OSObject *
properties
);Параметры
properties
Любой подкласс OSObject, чтобы быть интерпретированным методом реализации - например, OSDictionary, OSData и т.д. может все быть надлежащим.
Возвращаемое значение
IOReturn кодирует, чтобы быть возвращенным к вызывающей стороне.
Обсуждение
Этот метод не реализован IORegistryEntry, но доступен ядру и клиентам неядра для установки свойств в ключе реестра. IOUserClient обеспечивает соединение базируемый, более управляемый доступ к этой функциональности и может быть более подходящим для многого использования, так как нет никакого дифференцирования между клиентами, доступными этому методу.
-
Синхронизированный метод создать и добавить свойство OSData к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const char *
aKey
, void *bytes
, unsigned intlength
);Параметры
aKey
Имя свойства как струна до.
bytes
Значение свойства как указатель. OSData скопирует эти данные.
length
Размер свойства в байтах, для OSData.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Свойство создается, поскольку OSData, скопированный с данных, которыми снабжают, и длины, установил в таблице свойства с именем, и выпущенный.
-
Синхронизированный метод создать и добавить свойство OSBoolean к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const char *
aKey
, boolaBoolean
);Параметры
aKey
Имя свойства как струна до.
aBoolean
Булево значение свойства.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Свойство создано как OSBoolean из предоставленного значения, установлено в таблице свойства с именем и выпущено.
-
setProperty (символ константы *, символ константы *) - setProperty (символ константы *, символ константы *)
Синхронизированный метод создать и добавить свойство OSString к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const char *
aKey
, const char *aString
);Параметры
aKey
Имя свойства как струна до.
aString
Значение свойства как струна до.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Свойство создано как OSString из предоставленной струны до, установлено в таблице свойства с именем и выпущено.
-
Синхронизированный метод добавить свойство к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const char *
aKey
, OSObject *anObject
);Параметры
aKey
Имя свойства как струна до.
anObject
Значение свойства.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
setProperty (символ константы *, длинный длинный, интервал без знака без знака) - setProperty (символ константы *, длинный длинный, интервал без знака без знака)
Синхронизированный метод создать и добавить свойство OSNumber к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const char *
aKey
, unsigned long longaValue
, unsigned intaNumberOfBits
);Параметры
aKey
Имя свойства как струна до.
aValue
Числовое значение свойства.
aNumberOfBits
Размер свойства в битах, для OSNumber.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства. Свойство создано как OSNumber из предоставленного значения и размера, установлено в таблице свойства с именем и выпущено.
-
Синхронизированный метод добавить свойство к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const OSString *
aKey
, OSObject *anObject
);Параметры
aKey
Имя свойства как OSString.
anObject
Значение свойства.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
Синхронизированный метод добавить свойство к таблице свойства ключа реестра.
Объявление
C++
virtual bool setProperty( const OSSymbol *
aKey
, OSObject *anObject
);Параметры
aKey
Свойства называют как OSSymbol.
anObject
Значение свойства.
Возвращаемое значение
истина на успехе или ложь на отказе ресурсов.
Обсуждение
Этот метод добавит или заменит свойство в таблице свойства ключа реестра, с помощью OSDictionary:: семантика setObject. Этот метод синхронизируется с другими доступами IORegistryEntry к таблице свойства.
-
Замените таблицу свойства ключа реестра.
Объявление
C++
virtual void setPropertyTable( OSDictionary *
dict
);Параметры
dict
Новый словарь, который будет использоваться в качестве таблицы свойства записи.
Обсуждение
Этот метод выпустит текущую таблицу свойства запись и заменит его другим, сохраняя новую таблицу свойства.
-
Объявление
C++
typedef IOReturn ( *Action)( OSObject *target, void *arg0, void *arg1, void *arg2, void *arg3);
Параметры
target
Target функции, может использоваться в качестве refcon. Отметьте, была ли функция C++ указана, этот параметр является неявно первым параметром в списке параметров целевой функции членства.
arg0
Параметр действию от выполненной работы.
arg1
Параметр действию от выполненной работы.
arg2
Параметр действию от выполненной работы.
arg3
Параметр действию от выполненной работы.
Обсуждение
Тип и параметры выноски C функция, использующаяся, когда runCommand выполняется клиентом. Бросок к этому типу, когда Вы хотите, чтобы использовалась функция членства C++. Обратите внимание на то, что arg1 - arg3 параметры передаются, прямо проходят к выноске действия.
Оператор импорта
Objective C
#include <IOCommandGate.h>;
Доступность
Доступный в OS X v10.0 через OS X v10.5.
-
Объявление
C++
struct ExpansionData { uint64_t fRegistryEntryID; };
Обсуждение
Эта структура будет использоваться для расширения capablilties этого класса в будущем.
-
Зарезервированный для будущего использования. (Только внутреннее использование)
Объявление
C++
ExpansionData * reserved;