Função MprConfigInterfaceTransportEnum (mprapi.h)

Artigo
03/15/2023

A função MprConfigInterfaceTransportEnum enumera os transportes configurados na interface especificada.

Sintaxe

DWORD MprConfigInterfaceTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

Parâmetros

[in] hMprConfig

Manipule para a configuração do roteador. Obtenha esse identificador chamando MprConfigServerConnect.

[in] hRouterInterface

Manipule para a configuração de interface da qual enumerar os transportes. Obtenha esse identificador chamando MprConfigInterfaceCreate ou MprConfigInterfaceEnum.

[in] dwLevel

Um valor DWORD que descreve o formato no qual as informações são retornadas no parâmetro lplpBuffer . Deve ser zero.

[in, out] lplpBuffer

Na entrada, um ponteiro não NULL .

Após a conclusão bem-sucedida, um ponteiro para uma matriz de estruturas de MPR_IFTRANSPORT_0 . Libere esse buffer de memória chamando MprConfigBufferFree.

[in] dwPrefMaxLen

Especifica o comprimento máximo preferencial dos dados retornados (em bytes de 8 bits). Se esse parâmetro for -1, o buffer retornado será grande o suficiente para conter todas as informações disponíveis.

[out] lpdwEntriesRead

Ponteiro para uma variável DWORD . Essa variável recebe o número total de entradas que foram enumeradas da posição de currículo atual.

[out] lpdwTotalEntries

Ponteiro para uma variável DWORD . Essa variável recebe o número total de entradas que poderiam ter sido enumeradas da posição de currículo atual.

[in, out, optional] lpdwResumeHandle

Ponteiro para uma variável DWORD .

Na entrada, o identificador deve ser zero na primeira chamada e deixado inalterado em chamadas subsequentes.

Na saída, essa variável contém um identificador de currículo usado para continuar a enumeração. Se o identificador for NULL, a enumeração será concluída.

Se ocorrer um erro na enumeração, esse identificador será inválido.

Esse parâmetro é opcional. Se o aplicativo de chamada especificar NULL para esse parâmetro, a função não retornará um identificador de retomada.

Valor retornado

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	Uma das seguintes condições é verdadeira: hMprConfig é NULL. HRouterInterface é NULL. dwLevel não é zero. lplpBuffer é NULL. dwPrefMaxLen é menor que o tamanho de uma única estrutura MPR_IFTRANSPORT_0 . lpdwEntriesRead é NULL. lpdwTotalEntries é NULL.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para concluir a operação.
ERROR_NO_MORE_ITEMS	Não há mais entradas disponíveis na posição de currículo atual.
Outros	Use FormatMessage para recuperar a mensagem de erro do sistema que corresponde ao código de erro retornado.

Requisitos


Cliente mínimo com suporte	Nenhum compatível
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	mprapi.h
Biblioteca	Mprapi.lib
DLL	Mprapi.dll