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

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

Разработчик

Ссылка класса IOUSBInterface

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

На этой странице
Язык:

IOUSBInterface

Объект, представляющий интерфейс устройства на Шине USB.

Этот класс обеспечивает функциональность, чтобы найти каналы интерфейса и считать дескрипторы, связанные с интерфейсом. Когда интерфейс открыт () редактор, все его каналы создаются

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

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

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

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

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

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

Objective C

@import Kernel;

Доступность

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

Прочие условия
  • DeviceRequest (IOUSBDevRequest *, IOUSBCompletion *) - DeviceRequest (IOUSBDevRequest *, IOUSBCompletion *)

    Отправляет запрос управления к каналу управления по умолчанию в устройстве (нуль канала)

    Объявление

    C++

    virtual IOReturn DeviceRequest( IOUSBDevRequest *request, IOUSBCompletion *completion = 0);

    Параметры

    request

    Блок параметра для отправки к устройству

    completion

    Функция для вызова, когда завершается запрос. Если опущено тогда DeviceRequest () выполняется синхронно, блокируя, пока запрос не завершен. Если запрос является асинхронным, клиент должен удостовериться, что IOUSBDevRequest не выпущен, пока обратный вызов не произошел.

  • DeviceRequest (IOUSBDevRequestDesc *, IOUSBCompletion *) - DeviceRequest (IOUSBDevRequestDesc *, IOUSBCompletion *)

    Отправляет запрос управления к каналу управления по умолчанию в устройстве (нуль канала)

    Объявление

    C++

    virtual IOReturn DeviceRequest( IOUSBDevRequestDesc *request, IOUSBCompletion *completion = 0);

    Параметры

    request

    Блок параметра для отправки к устройству (с pData как IOMemoryDesriptor)

    completion

    Функция для вызова, когда завершается запрос. Если опущено тогда DeviceRequest () выполняется синхронно, блокируя, пока запрос не завершен. Если запрос является асинхронным, клиент должен удостовериться, что IOUSBDevRequest не выпущен, пока обратный вызов не произошел.

  • EnableRemoteWake - EnableRemoteWake

    Включит или отключит USB 3.0 удаленная функция следа для интерфейса

    Объявление

    C++

    virtual IOReturn EnableRemoteWake( boolenable);

    Параметры

    enable

    Разрешаем ли мы (истина) или отключаем (ложь) удаленный след..

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

    возвраты kIOReturnSuccess, если запрос завершается успешно, иначе возвращают результат Запроса Устройства установить функцию.

  • FindNextAltInterface - FindNextAltInterface

    Объявление

    C++

    virtual const IOUSBInterfaceDescriptor *FindNextAltInterface( const IOUSBInterfaceDescriptor *current, IOUSBFindInterfaceRequest *request);

    Параметры

    current

    интерфейсный дескриптор, чтобы начать искать от, NULL для запуска в альтернативном интерфейсе 0.

    request

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

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

    Указатель на соответствующий интерфейсный дескриптор или NULL, если ни один не соответствует.

    Обсуждение

    возвратите альтернативный интерфейсный дескриптор, удовлетворяющий требования, указанные в запросе или NULL, если нет никого. запрос обновляется со свойствами возвращенного интерфейса.

  • FindNextAssociatedDescriptor - FindNextAssociatedDescriptor

    Объявление

    C++

    virtual const IOUSBDescriptorHeader * FindNextAssociatedDescriptor( const void *current, UInt8type);

    Параметры

    current

    Дескриптор, чтобы начать искать от, NULL для запуска с начала списка.

    type

    Тип дескриптора для поиска, или kUSBAnyDesc для возврата любого типа дескриптора.

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

    Указатель на дескриптор или NULL, если не найдены никакие дескрипторы соответствия.

    Обсуждение

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

  • FindNextPipe (IOUSBPipe *, IOUSBFindEndpointRequest *) - FindNextPipe (IOUSBPipe *, IOUSBFindEndpointRequest *)

    Объявление

    C++

    virtual IOUSBPipe *FindNextPipe( IOUSBPipe *current, IOUSBFindEndpointRequest *request);

    Параметры

    current

    Канал, чтобы начать искать от, NULL для запуска с начала списка.

    request

    Требования для канала для соответствия, обновленный со свойствами найденного канала.

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

    Указатель на канал или NULL, если никакой канал не соответствует запрос.

    Обсуждение

    Найдите канал интерфейса, соответствующего требования, или запускающиеся с начала списка канала интерфейса или от указанного канала.

  • FindNextPipe (IOUSBPipe *, IOUSBFindEndpointRequest *, bool) - FindNextPipe (IOUSBPipe *, IOUSBFindEndpointRequest *, bool)

    Объявление

    C++

    virtual IOUSBPipe* FindNextPipe( IOUSBPipe *current, IOUSBFindEndpointRequest *request, boolwithRetain);

    Параметры

    current

    Канал, чтобы начать искать от, NULL для запуска с начала списка.

    request

    Требования для канала для соответствия, обновленный со свойствами найденного канала.

    withRetain

    Передайте истину для сохранения, и клиент должен выпустить ее позже после ее использования.

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

    Указатель на канал или NULL, если никакой канал не соответствует запрос.

    Обсуждение

    Найдите канал интерфейса, соответствующего требования, или запускающиеся с начала списка канала интерфейса или от указанного канала.

  • GetAlternateSetting - GetAlternateSetting

    Объявление

    C++

    virtual UInt8 GetAlternateSetting();

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

    альтернативная установка

    Обсуждение

    возвращает альтернативную установку для этого интерфейса.

  • GetConfigValue - GetConfigValue

    Объявление

    C++

    virtual UInt8 GetConfigValue();

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

    Значение конфигурации устройства.

    Обсуждение

    возвращает значение конфигурации устройства для интерфейса

  • GetDevice - GetDevice

    Объявление

    C++

    virtual IOUSBDevice *GetDevice();

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

    Указатель на объект IOUSBDevice, который является родителем этого объекта IOUSBInterface.

    Обсуждение

    возвращает устройство, из которого интерфейс является частью.

  • GetEndpointProperties - GetEndpointProperties

    Возвращает свойства конечной точки, возможно в альтернативном интерфейсе.

    Объявление

    C++

    virtual IOReturn GetEndpointProperties( UInt8alternateSetting, UInt8endpointNumber, UInt8direction, UInt8 *transferType, UInt16 *maxPacketSize, UInt8 *interval);

    Параметры

    alternateSetting

    указывает желаемую альтернативную установку

    endpointNumber

    указывает число конечной точки

    direction

    указывает направление (kUSBIn, kUSBOut)

    transferType

    указатель для содержания типа передачи (kUSBControl, kUSBBulk, и т.д.) конечной точки, если найдено.

    maxPacketSize

    указатель для содержания maxPacketSize в дескрипторе конечной точки.

    interval

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

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

    возвраты kIOReturnSuccess, если конечная точка найдена, и kIOUSBEndpointNotFound, если это не.

  • GetEndpointPropertiesV3 - GetEndpointPropertiesV3

    Возвращает свойства конечной точки, возможно в альтернативном интерфейсе, включая любую информацию от Сопутствующего Дескриптора SuperSpeed

    Объявление

    C++

    virtual IOReturn GetEndpointPropertiesV3( IOUSBEndpointProperties *endpointProperties);

    Параметры

    endpointProperties

    Указатель на структуру IOUSBEndpointProperties, которая на успех будет содержать информацию для конечной точки. bVersion поле должно быть инициализировано с версией структуры (см. перечисление USBEndpointVersion в USB.h). bAlternateSetting, bEndpointNumber, и bDirection (kUSBIn, kUSBOut) MUST также быть заполненным в значениями для желаемого дескриптора. Не то, чтобы значение bMaxStreams для Объемных конечных точек является значением, указанным bmAttributes полем в сопутствующем дескрипторе SuperSpeed.

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

    возвраты kIOReturnSuccess, если конечная точка найдена, и kIOUSBEndpointNotFound, если это не.

  • GetInterfaceClass - GetInterfaceClass

    Объявление

    C++

    virtual UInt8 GetInterfaceClass();

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

    интерфейсный класс

    Обсуждение

    возвращает код класса для этого интерфейса (присвоенный USB), значение нуля резервируется, если значение является FFh, интерфейсный класс специфичен для поставщика, все другие значения резервируются для присвоения USB

  • GetInterfaceNumber - GetInterfaceNumber

    Объявление

    C++

    virtual UInt8 GetInterfaceNumber();

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

    интерфейсный индекс

    Обсуждение

    возвращает нуль базируемое значение, идентифицирующее индекс в массиве параллельных интерфейсов, поддерживаемых текущей конфигурацией

  • GetInterfaceProtocol - GetInterfaceProtocol

    Объявление

    C++

    virtual UInt8 GetInterfaceProtocol();

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

    интерфейсный индекс

    Обсуждение

    возвращает код протокола (присвоенный USB).

  • GetInterfaceStatus - GetInterfaceStatus

    Возвращает результат выпуска запроса GET_STATUS на устройстве для этого интерфейса.

    Объявление

    C++

    virtual IOReturn GetInterfaceStatus( USBStatus *status);

    Параметры

    status

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

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

    возвраты kIOReturnSuccess, если запрос завершается успешно, иначе возвращают результат Запроса Устройства.

  • GetInterfaceStringIndex - GetInterfaceStringIndex

    Объявление

    C++

    virtual UInt8 GetInterfaceStringIndex();

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

    индекс строк

    Обсуждение

    возвращает индекс строкового дескриптора, описывающего интерфейс

  • GetInterfaceSubClass - GetInterfaceSubClass

    Объявление

    C++

    virtual UInt8 GetInterfaceSubClass();

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

    интерфейсный подкласс

    Обсуждение

    возвращает код подкласса (присвоенный USB). Эти коды квалифицированы значением, возвращенным GetInterfaceClass

  • GetNumEndpoints - GetNumEndpoints

    Объявление

    C++

    virtual UInt8 GetNumEndpoints();

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

    число конечных точек

    Обсуждение

    возвращает число конечных точек, используемых этим интерфейсом (исключая нуль конечной точки устройства. Если значение является нулем, этот интерфейс только использует нуль конечной точки.

  • GetPipeObj - GetPipeObj

    Объявление

    C++

    virtual IOUSBPipe *GetPipeObj( UInt8index);

    Параметры

    index

    значение от нуля до kUSBMaxPipes-1

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

    Объект IOUSBPipe. Обратите внимание на то, что клиенту не принадлежит ссылка на этот канал, таким образом, клиент должен сохранить () объект IOUSBPipe при необходимости.

    Обсуждение

    возвращает дескриптор каналу в соответствующем индексе

  • RecreateStreams - RecreateStreams

    Объявление

    C++

    virtual IOReturn RecreateStreams( void);

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

    возвраты kIOReturnSuccess, если успешный.

    Обсуждение

    Воссоздайте помнившие потоки после того, как будет сброшено устройство.

  • RememberStreams - RememberStreams

    Объявление

    C++

    virtual IOReturn RememberStreams( void);

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

    возвраты kIOReturnSuccess, если успешный.

    Обсуждение

    Обратите внимание, какие каналы имеют потоки, таким образом, они могут быть воссозданы позже.

  • RememberStreams. - RememberStreams.

    Объявление

    C++

    virtual IOReturn RememberStreams( void);

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

    возвраты kIOReturnSuccess, если успешный.

    Обсуждение

    Обратите внимание, какие каналы имеют потоки, таким образом, они могут быть воссозданы позже.

  • SetAlternateInterface - SetAlternateInterface

    Объявление

    C++

    virtual IOReturn SetAlternateInterface( IOService *forClient, UInt16alternateSetting);

    Параметры

    forClient

    Клиент, запрашивающий альтернативную установку. У этого клиента должен быть интерфейс, открытый для выполнения запроса.

    alternateSetting

    Установка альтернативы (от интерфейсного дескриптора альтернативного интерфейса).

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

    ошибка эксклюзивного доступа, если интерфейс не открыт. иначе результат транзакции

    Обсуждение

    Выберите указанный альтернативный интерфейс.

  • SetFunctionSuspendFeature - SetFunctionSuspendFeature

    Выпускает SET_FEATURE (FUNCTION_SUSPEND) к интерфейсу.

    Объявление

    C++

    virtual IOReturn SetFunctionSuspendFeature( UInt8options);

    Параметры

    options

    Приостановить опции передали Запросу Устройства.

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

    возвраты kIOReturnSuccess, если запрос завершается успешно, иначе возвращают результат Запроса Устройства.