função WinUsb_GetPipePolicy (winusb.h)

Artigo
08/27/2023

A função WinUsb_GetPipePolicy recupera a política de um pipe específico associado a um ponto de extremidade no dispositivo. Essa é uma operação síncrona.

Sintaxe

BOOL WinUsb_GetPipePolicy(
  [in]      WINUSB_INTERFACE_HANDLE InterfaceHandle,
  [in]      UCHAR                   PipeID,
  [in]      ULONG                   PolicyType,
  [in, out] PULONG                  ValueLength,
  [out]     PVOID                   Value
);

Parâmetros

[in] InterfaceHandle

Um identificador opaco para uma interface que contém o ponto de extremidade ao qual o pipe está associado.

Para consultar o pipe associado ao ponto de extremidade na primeira interface, use o identificador retornado por WinUsb_Initialize. Para todas as outras interfaces, use o identificador para a interface de destino, recuperada por WinUsb_GetAssociatedInterface.

[in] PipeID

Um valor de 8 bits que consiste em um endereço de 7 bits e um bit de direção. Esse parâmetro corresponde ao campo bEndpointAddress no descritor de ponto de extremidade.

[in] PolicyType

Uma variável ULONG que especifica o parâmetro de política a ser recuperado. O valor atual do parâmetro de política é recuperado o parâmetro Value . Para obter informações sobre o comportamento das políticas de pipe, consulte Funções do WinUSB para modificação da política de pipe.

[in, out] ValueLength

Um ponteiro para o tamanho, em bytes, do buffer para o qual Value aponta. Na saída, ValueLength recebe o tamanho, em bytes, dos dados que foram copiados para o buffer Valor .

[out] Value

Um ponteiro para um buffer que recebe o valor da política de pipe especificado.

Valor retornado

WinUsb_GetPipePolicyretornará 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.

GetLastError pode retornar o código de erro a seguir.