Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка IOPowerSources.h

Опции
Развертывание Target:

На этой странице

Ссылка IOPowerSources.h

IOPowerSources обеспечивает универсальный доступ к состоянию источников питания, присоединенных к системе. Когда любые данные источника питания изменяются, можно получить уведомление изменения. «Источники питания» в настоящее время включают устройства UPS и батареи.

Заголовок следует за семантикой CF, в которой это - ответственность вызывающей стороны перед CFRelease () что-либо возвращенное функцией «Копии», и вызывающая сторона не должна CFRelease () ничто возвращенное «Получить» функцией.

Включенные заголовки

  • <sys/cdefs.h>

Функции

  • Возвращает предполагаемые минуты, оставаясь, пока все источники питания (батарея и/или UPS's) не пусты, или возвраты kIOPSTimeRemainingUnlimited если присоединено к неограниченному источнику питания.

    Объявление

    Objective C

    CFTimeInterval IOPSGetTimeRemainingEstimate ( void );

    Возвращаемое значение

    Возвраты kIOPSTimeRemainingUnknown если OS не может определить время, оставаясь.

    Возвраты kIOPSTimeRemainingUnlimited если система имеет неограниченный источник питания.

    Иначе возвращает положительное число типа CFTimeInterval, указывая время, оставаясь в секундах, пока не истощаются все источники питания.

    Обсуждение

    Если присоединено к «Неограниченному» источнику питания, как питание переменным током или любой внешний источник, возвращаемое значение kIOPSTimeRemainingUnlimited

    Если система находится на «Ограниченном» питании, как батарея или UPS, но все еще вычисляет время, оставаясь, который может взять спустя несколько секунд после каждого события питания системы (например, просыпающийся от сна или отключающий питание переменным током), возвращаемое значение kIOPSTimeRemainingUnknown

    Иначе, если система находится на «Ограниченном» питании, и система имеет точную оценку оставлений времени, система возвращает оценку CFTimeInterval времени, оставаясь, пока система не вне заряда батареи.

    Если Вы запрашиваете более подробную информацию батареи, использовать IOPSCopyPowerSourcesInfo> и IOPSGetPowerSourceDescription>.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.7 и позже.

  • Возвращает CFDictionary, описывающий присоединенный (AC) внешний адаптер питания (если присоединяется какой-либо внешний адаптер питания.

    Объявление

    Objective C

    CFDictionaryRef IOPSCopyExternalPowerAdapterDetails ( void );

    Возвращаемое значение

    Возвращает CFDictionary на успехе. Вызывающая сторона должна выпустить возвращенный словарь. Если существует ошибка, NULL возвратов, если никакой адаптер не присоединяется, или.

    Обсуждение

    Используйте kIOPSPowerAdapter... ключи, описанные в IOPSKeys.h для интерпретации возвращенного CFDictionary.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.6 и позже.

  • Возвращает блоб информации об Источнике питания в непрозрачном CFTypeRef.

    Объявление

    Objective C

    CFTypeRef IOPSCopyPowerSourcesInfo ( void );

    Возвращаемое значение

    NULL, если с ошибками встретились, CFTypeRef иначе. Вызывающая сторона должна CFRelease () возвращаемое значение, сделано получая доступ к нему.

    Обсуждение

    Клиенты не должны непосредственно получать доступ к данным в возвращенном CFTypeRef - они должны использовать функции средства доступа IOPSCopyPowerSourcesList и IOPSGetPowerSourceDescription, вместо этого.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.2 и позже.

  • Возвращает CFArray дескрипторов Источника питания, каждый тип CFTypeRef.

    Объявление

    Objective C

    CFArrayRef IOPSCopyPowerSourcesList ( CFTypeRef blob );

    Параметры

    blob

    Берет CFTypeRef, возвращенный IOPSCopyPowerSourcesInfo ()

    Возвращаемое значение

    NULL возвратов, если с ошибками встретились, иначе CFArray CFTypeRefs. Вызывающая сторона должна CFRelease () возвращенный CFArrayRef.

    Обсуждение

    Вызывающая сторона не должна непосредственно получать доступ к CFTypeRefs, но должна использовать IOPSGetPowerSourceDescription на каждом элементе CFArrayRef.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.2 и позже.

  • Возвращает CFDictionary с читаемой информацией об определенном источнике питания.

    Объявление

    Objective C

    CFDictionaryRef IOPSGetPowerSourceDescription ( CFTypeRef blob, CFTypeRef ps );

    Параметры

    blob

    CFTypeRef, возвращенный IOPSCopyPowerSourcesInfo ()

    ps

    Один из CFTypeRefs в CFArray, возвращенном IOPSCopyPowerSourcesList ()

    Возвращаемое значение

    NULL возвратов, если с ошибкой встретились, иначе CFDictionary. Вызывающая сторона не должна выпускать возвращенный CFDictionary - это будет выпущено как часть CFTypeRef, возвращенного IOPSCopyPowerSourcesInfo ().

    Обсуждение

    Посмотрите струны до, определенные в IOPSKeys.h для определенных ключей в словарь. Не ожидайте, что все ключи будут присутствовать в любом словаре. Некоторые источники питания, например, могут не поддерживать ключ «Time Remaining To Empty», и он не будет присутствовать в их словарях.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.2 и позже.

  • Указывает источник питания, из которого в настоящее время рисует компьютер.

    Объявление

    Objective C

    CFStringRef IOPSGetProvidingPowerSourceType( CFTypeRef snapshot);

    Параметры

    snapshot

    CFTypeRef, возвращенный IOPSCopyPowerSourcesInfo (); вызывающая сторона может передать NULL.

    Возвращаемое значение

    Один из: CFSTR (kIOPMACPowerKey), CFSTR (kIOPMBatteryPowerKey), CFSTR (kIOPMUPSPowerKey)

    Обсуждение

    Определяет, какой источник питания обеспечивает питание.

  • Указывает источник питания, из которого в настоящее время рисует компьютер.

    Объявление

    Objective C

    CFStringRef IOPSGetProvidingPowerSourceType( CFTypeRef snapshot);

    Параметры

    snapshot

    CFTypeRef, возвращенный IOPSCopyPowerSourcesInfo ()

    Возвращаемое значение

    Один из: CFSTR (kIOPMACPowerKey), CFSTR (kIOPMBatteryPowerKey), CFSTR (kIOPMUPSPowerKey)

    Обсуждение

    Определяет, какой источник питания обеспечивает питание.

  • Возвращает CFRunLoopSourceRef, уведомляющий вызывающую сторону, когда изменяется информация об источнике питания.

    Объявление

    Objective C

    CFRunLoopSourceRef IOPSNotificationCreateRunLoopSource ( IOPowerSourceCallbackType callback, void *context );

    Параметры

    callback

    Функция, которую вызовут каждый раз, когда любой источник питания добавляется, удалила, или изменения.

    context

    Любой определяемый пользователем указатель, переданный обратному вызову IOPowerSource.

    Возвращаемое значение

    NULL возвратов, если с ошибкой встретились, иначе CFRunLoopSource. Вызывающая сторона должна выпустить CFRunLoopSource.

    Обсуждение

    Возвращает CFRunLoopSourceRef для планирования с Вашим CFRunLoop. Если Ваш проект не использует CFRunLoop, можно альтернативно получить уведомления через порт Маха, отгрузку или сигнал, через notify.h использование имени kIOPSTimeRemainingNotificationKey

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.2 и позже.

  • Указывает, является ли система на уровне предупреждения низкого уровня заряда.

    Объявление

    Objective C

    IOPSLowBatteryWarningLevel IOPSGetBatteryWarningLevel ( void );

    Обсуждение

    Если Ваше выполнение приложения в полноэкранном режиме и закрывает предупреждения низкого уровня заряда индикатора батареи OS X, необходимо предупредить пользователя, по крайней мере, когда система находится в kIOPSLowBatteryWarnFinal.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.6 и позже.

Типы данных

См. Обзор для документации уровня заголовка.

  • Батарея может обеспечить не больше, чем 10 минут времени выполнения.

    Объявление

    Objective C

    typedef enum { /*! @constant kIOPSLowBatteryWarningNone */ kIOPSLowBatteryWarningNone = 1, /*! @constant kIOPSLowBatteryWarningEarly */ kIOPSLowBatteryWarningEarly = 2, /*! @constant kIOPSLowBatteryWarningFinal */ kIOPSLowBatteryWarningFinal = 3 } IOPSLowBatteryWarningLevel;

    Константы

    • kIOPSLowBatteryWarningNone

      kIOPSLowBatteryWarningNone

      Доступный в OS X v10.6 и позже.

    • kIOPSLowBatteryWarningEarly

      kIOPSLowBatteryWarningEarly

      Доступный в OS X v10.6 и позже.

    • kIOPSLowBatteryWarningFinal

      kIOPSLowBatteryWarningFinal

      Доступный в OS X v10.6 и позже.

    Обсуждение

    OS X не делает гарантий, что система должна остаться в Предупреждении Финала в течение 10 минут. Батареи часто калибруются по-другому и могут обеспечить время выполнения для больше, или меньше, чем приблизительно 10 минут.

    Оператор импорта

    Objective C

    @import IOKit;

    Доступность

    Доступный в OS X v10.6 и позже.

Константы

См. Обзор для документации уровня заголовка.

  • Объявление

    Objective C

    #define kIOPSNotifyLowBattery "com.apple.system.powersources.lowbattery" #define kIOPSTimeRemainingNotificationKey "com.apple.system.powersources.timeremaining" #define kIOPSTimeRemainingUnknown ((CFTimeInterval)-1.0) #define kIOPSTimeRemainingUnlimited ((CFTimeInterval)-2.0)

    Константы

    • kIOPSNotifyLowBattery

      kIOPSNotifyLowBattery

      Ключ Notify (3). Когда время работы от аккумулятора, оставаясь заскакивает в warnable уровень, система поставляет уведомления на этом ключе.

      Доступный в OS X v10.6 и позже.

    • kIOPSTimeRemainingNotificationKey

      kIOPSTimeRemainingNotificationKey

      Ключ струны до для уведомления, стреляющего, когда изменяется оставление времени источника (ов) питания.

      Использование уведомляет (3) API для регистрации для уведомлений.

      Доступный в OS X v10.7 и позже.

    • kIOPSTimeRemainingUnknown

      kIOPSTimeRemainingUnknown

      Возможное возвращаемое значение от IOPSGetTimeRemainingEstimate

      Указывает, что система подключена к ограниченному источнику питания, но система все еще вычисляет оценку оставлений времени. Проверьте на допустимую оценку снова когда уведомление kIOPSPowerSourcesNotificationKey огни.

      Доступный в OS X v10.7 и позже.

    • kIOPSTimeRemainingUnlimited

      kIOPSTimeRemainingUnlimited

      Возможное возвращаемое значение от IOPSGetTimeRemainingEstimate

      Указывает, что система подключена к источнику внешнего питания без ограничения по времени.

      Доступный в OS X v10.7 и позже.