Función MprConfigInterfaceTransportGetInfo (mprapi.h)

Artículo
03/15/2023

La función MprConfigInterfaceTransportGetInfo recupera la información de configuración del cliente especificado en la interfaz especificada.

Sintaxis

DWORD MprConfigInterfaceTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterInterface,
  [in]                HANDLE  hRouterIfTransport,
  [in, out, optional] LPBYTE  *ppInterfaceInfo,
  [out, optional]     LPDWORD lpdwInterfaceInfoSize
);

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 va a recuperar la información de cliente especificada. Obtenga este identificador llamando a MprConfigInterfaceCreate, MprConfigInterfaceGetHandle o MprConfigInterfaceEnum.

[in] hRouterIfTransport

Controle la configuración de transporte desde la que se va a recuperar la información de cliente especificada. Obtenga este identificador llamando a MprConfigInterfaceTransportAdd, MprConfigInterfaceTransportGetHandle o MprConfigInterfaceTransportEnum. Los tipos de protocolo de transporte admitidos aparecen en Identificadores de transporte.

[in, out, optional] ppInterfaceInfo

En la entrada, puntero a una variable de puntero.

En la salida, esta variable de puntero apunta a un encabezado de información que contiene información de configuración para el cliente. Use las funciones de encabezado de información para manipular encabezados de información. Libere esta memoria llamando a MprConfigBufferFree.

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

[out, optional] lpdwInterfaceInfoSize

Puntero a una variable DWORD . Esta variable recibe el tamaño, en bytes, de los datos a los que apunta ppInterfaceInfo.

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro. Sin embargo, si ppInterfaceInfo no es NULL, este parámetro no puede ser NULL. Para obtener más información, vea la sección Comentarios más adelante en este tema.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR. Para obtener más información, vea la sección Comentarios más adelante en este tema.

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. hRouterIfTransport es NULL. ppInterfaceInfo no es NULL, pero lpdwInterfaceInfoSize es NULL.
ERROR_NO_SUCH_INTERFACE	La interfaz especificada por hRouterIfTransport no se encontró en la configuración del enrutador o el transporte especificado por hRouterIfTransport no estaba habilitado en la interfaz especificada.
ERROR_NOT_ENOUGH_MEMORY	Recursos insuficientes para completar la operación.
Otros	Use FormatMessage para recuperar el mensaje de error del sistema que corresponde al código de error devuelto.

Comentarios

Si el parámetro ppInterfaceInfo es NULL, MprConfigInterfaceTransportGetInfo no hace nada y devuelve inmediatamente con un valor de NO_ERROR.

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