Función MprConfigInterfaceTransportEnum (mprapi.h)

Artículo
03/15/2023

La función MprConfigInterfaceTransportEnum enumera los transportes configurados en la interfaz especificada.

Sintaxis

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

Controle la configuración del enrutador. Obtenga este identificador llamando a MprConfigServerConnect.

[in] hRouterInterface

Controle la configuración de la interfaz desde la que se van a enumerar los transportes. Obtenga este identificador llamando a MprConfigInterfaceCreate o MprConfigInterfaceEnum.

[in] dwLevel

Valor DWORD que describe el formato en el que se devuelve la información en el parámetro lplpBuffer . Debe ser cero.

[in, out] lplpBuffer

En la entrada, un puntero distinto de NULL .

Al finalizar correctamente, un puntero a una matriz de estructuras de MPR_IFTRANSPORT_0 . Libere este búfer de memoria llamando a MprConfigBufferFree.

[in] dwPrefMaxLen

Especifica la longitud máxima preferida de los datos devueltos (en bytes de 8 bits). Si este parámetro es -1, el búfer devuelto es lo suficientemente grande como para contener toda la información disponible.

[out] lpdwEntriesRead

Puntero a una variable DWORD . Esta variable recibe el número total de entradas enumeradas a partir de la posición de reanudación actual.

[out] lpdwTotalEntries

Puntero a una variable DWORD . Esta variable recibe el número total de entradas que se podrían haber enumerado a partir de la posición de reanudación actual.

[in, out, optional] lpdwResumeHandle

Puntero a una variable DWORD .

En la entrada, el identificador debe ser cero en la primera llamada y dejar sin cambios en las llamadas posteriores.

En la salida, esta variable contiene un identificador de reanudación que se usa para continuar con la enumeración. Si el identificador es NULL, la enumeración se completa.

Si se produce un error en la enumeración, este identificador no es válido.

Este parámetro es opcional. Si la aplicación que realiza la llamada especifica NULL para este parámetro, la función no devuelve un identificador de reanudación.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor	Significado
ERROR_INVALID_PARAMETER	Una de las siguientes condiciones se cumple: hMprConfig es NULL. HRouterInterface es NULL. dwLevel no es cero. lplpBuffer es NULL. dwPrefMaxLen es menor que el tamaño de una única estructura de MPR_IFTRANSPORT_0 . lpdwEntriesRead es NULL. lpdwTotalEntries es NULL.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para completar la operación.
ERROR_NO_MORE_ITEMS	No hay más entradas disponibles en la posición de reanudación actual.
Otros	Use FormatMessage para recuperar el mensaje de error del sistema que corresponde al código de error devuelto.

Requisitos


Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	mprapi.h
Library	Mprapi.lib
Archivo DLL	Mprapi.dll