IOUPSPlugInInterface

Представляет и обеспечивает функции управления для устройства UPS.

Наследование

Не применимый

Соответствует

Не применимый

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

Не применимый не применимый

Прочие условия


    
    createAsyncEventSource
    - createAsyncEventSource

Используемый для создания асинхронного источника события цикла выполнения плагина.

Объявление

C++

IOReturn ( *createAsyncEventSource)( void *thisPointer, CFTypeRef *source);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`source`	Указатель на CFTypeRef. Ожидается что эта точка или к CFRunLoopSourceRef или к CFRunLoopTimerRef.

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

Код ошибки IOReturn.

Обсуждение

Это - метод назначения. Таким образом вызывающая сторона должна выпустить возвращающийся объект.


    
    getCapabilities
    - getCapabilities

Используемый для получения возможностей устройства UPS.

Объявление

C++

IOReturn ( *getCapabilities)( void *thisPointer, CFSetRef *capabilities);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`capabilities`	Указатель на CFSetRef, содержащий возможности.

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

Код ошибки IOReturn.

Обсуждение

Ключи определяются в IOPSKeys.h и начинаются с kIOPS. Это не метод назначения. Таким образом вызывающая сторона не выпускает возвращающийся CFSet.


    
    getEvent
    - getEvent

Используемый для опроса текущего состояния UPS.

Объявление

C++

IOReturn ( *getEvent)( void *thisPointer, CFDictionaryRef *event);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`event`	Указатель на CFDictionaryRef, содержащий состояние текущего события.

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

Код ошибки IOReturn.

Обсуждение

Ключи определяются в IOPSKeys.h и начинаются с kIOPS. Это не метод назначения. Таким образом вызывающая сторона не выпускает возвращающийся CFDictionary.


    
    getProperties
    - getProperties

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

Объявление

C++

IOReturn ( *getProperties)( void *thisPointer, CFDictionaryRef *properties);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`properties`	Указатель на CFDictionaryRef, содержащий свойства.

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

Код ошибки IOReturn.

Обсуждение

Ключи свойства определяются в IOPSKeys.h. Это не метод назначения. Таким образом вызывающая сторона не выпускает возвращающийся CFDictionary.


    
    sendCommand
    - sendCommand

Отправьте команду в UPS.

Объявление

C++

IOReturn ( *sendCommand)( void *thisPointer, CFDictionaryRef command);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`command`	CFDictionaryRef, содержащий команду.

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

Код ошибки IOReturn.

Обсуждение

Командные клавиши определяются в IOPSKeys.h и начинаются с kIOPSCommand. Ошибка должна быть возвращена, если Ваше устройство не знает, как реагировать на команду.


    
    setEventCallback
    - setEventCallback

Установите обратный вызов, который нужно вызвать для обработки события от UPS.

Объявление

C++

IOReturn ( *setEventCallback)( void *thisPointer, IOUPSEventCallbackFunction callback, void *callbackTarget, void *callbackRefcon);

Параметры

`thisPointer`	Интерфейс UPS для использования.
`callback`	Обработчик обратного вызова типа IOUPSEventCallbackFunction.
`callbackTarget`	Адрес, который будет предназначен этим обратным вызовом.
`callbackRefcon`	Пользователь указал ссылочное значение. Это будет передано всем функциям обратного вызова.

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

Код ошибки IOReturn.

Обсуждение

proivided метод обратного вызова нужно вызвать каждый раз, когда существует изменение состояния в UPS. Это должно использоваться в сочетании с createAsyncEventSource.