função WinUsb_GetAssociatedInterface (winusb.h)

Artigo
03/04/2024

A função WinUsb_GetAssociatedInterface recupera um identificador para uma interface associada. Esta é uma operação síncrona.

Sintaxe

BOOL WinUsb_GetAssociatedInterface(
  [in]  WINUSB_INTERFACE_HANDLE  InterfaceHandle,
  [in]  UCHAR                    AssociatedInterfaceIndex,
  [out] PWINUSB_INTERFACE_HANDLE AssociatedInterfaceHandle
);

Parâmetros

[in] InterfaceHandle

Um identificador opaco para a primeira interface (padrão) no dispositivo, que é retornado por WinUsb_Initialize.

[in] AssociatedInterfaceIndex

Um índice que especifica a interface associada a ser recuperada. Um valor de 0 indica a primeira interface associada, um valor de 1 indica a segunda interface associada e assim por diante.

[out] AssociatedInterfaceHandle

Um identificador para a interface associada. Os chamadores devem passar esse identificador de interface para as Funções do WinUSB expostas por Winusb.dll. Para fechar esse identificador, chame WinUsb_Free.

Retornar valor

WinUsb_GetAssociatedInterfaceretornará TRUE se a operação for bem-sucedida. Caso contrário, essa rotina retornará FALSE e o chamador poderá recuperar o erro registrado chamando GetLastError.

Código de retorno	Descrição
ERROR_ALREADY_EXISTS	WinUsb_GetAssociatedInterface já retornou um identificador para a interface especificada por AssociatedInterfaceIndex .
ERROR_INVALID_HANDLE	O chamador passou NULL no parâmetro InterfaceHandle .
ERROR_INVALID_PARAMETER	O valor AssociatedInterfaceIndex passado falhou em um marcar de estouro inteiro.
ERROR_NO_MORE_ITEMS	Uma interface não existe para o valor AssociatedInterfaceIndex especificado.
ERROR_NOT_ENOUGH_MEMORY	Indica que não há memória suficiente para executar a operação.

Comentários

A rotina WinUsb_GetAssociatedInterface recupera um identificador opaco.

A primeira interface associada é a interface que segue imediatamente a interface cujo identificador o WinUsb_Initialize rotina recupera.

O identificador que WinUsb_GetAssociatedInterface retorna deve ser liberado chamando WinUsb_Free.

Os chamadores de WinUsb_GetAssociatedInterface podem recuperar apenas um identificador para cada interface. Se um chamador tentar recuperar mais de um identificador para a mesma interface, a rotina falhará com um erro de ERROR_ALREADY_EXISTS.