Función MprConfigTransportGetInfo (mprapi.h)

Artículo
03/15/2023

La función MprConfigTransportGetInfo recupera la configuración del protocolo de transporte especificado del enrutador.

Sintaxis

DWORD MprConfigTransportGetInfo(
  [in]                HANDLE  hMprConfig,
  [in]                HANDLE  hRouterTransport,
  [in, out, optional] LPBYTE  *ppGlobalInfo,
  [out, optional]     LPDWORD lpdwGlobalInfoSize,
  [in, out, optional] LPBYTE  *ppClientInterfaceInfo,
  [out, optional]     LPDWORD lpdwClientInterfaceInfoSize,
  [in, out, optional] LPWSTR  *lplpwsDLLPath
);

Parámetros

[in] hMprConfig

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

[in] hRouterTransport

Identificador de la configuración del protocolo de transporte que se está recuperando. Obtenga este identificador llamando a MprConfigTransportCreate, MprConfigTransportGetHandle o MprConfigTransportEnum. Los tipos de protocolo de transporte admitidos aparecen en Identificadores de transporte.

[in, out, optional] ppGlobalInfo

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 global para el transporte. Use las funciones de encabezado de información para manipular encabezados de información. Libere este búfer 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 recupera la información global.

[out, optional] lpdwGlobalInfoSize

Puntero a una variable DWORD . Esta variable recibe el tamaño, en bytes, del búfer devuelto a través del parámetro ppGlobalInfo .

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro. Sin embargo, si ppGlobalInfo no es NULL, este parámetro no puede ser NULL.

[in, out, optional] ppClientInterfaceInfo

En la entrada, puntero a una variable de puntero.

En la salida, este puntero apunta a un encabezado de información que contiene información de interfaz predeterminada para los enrutadores cliente para este transporte. Use las funciones de encabezado de información para manipular encabezados de información. Libere el búfer 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 recupera la información de la interfaz.

[out, optional] lpdwClientInterfaceInfoSize

Puntero a una variable DWORD . Esta variable recibe el tamaño, en bytes, del búfer devuelto a través del parámetro ppClientInterfaceInfo .

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro. Sin embargo, si ppClientInterfaceInfo no es NULL, este parámetro no puede ser NULL.

[in, out, optional] lplpwsDLLPath

En la entrada, puntero a un puntero a una cadena Unicode terminada en null.

En la salida, la cadena Unicode recibe el nombre del archivo DLL del administrador de enrutadores para el transporte especificado.

Este parámetro es opcional. Si la aplicación que realiza la llamada especifica NULL para este parámetro, la función no recupera el nombre del archivo DLL del administrador de enrutadores.

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	Se cumple al menos una de las siguientes condiciones: hMprConfig es NULL hRouterTransport es NULL ppGlobalInfo no es NULL, pero lpdwGlobalInfoSize es NULL. ppClientInterfaceInfo no es NULL, pero lpdwClientInterfaceInfo es NULL.
ERROR_UNKNOWN_PROTOCOL_ID	La configuración del protocolo de transporte que corresponde a hRouterTransport no se encontró en la configuración del enrutador.
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 los parámetros pGlobalInfo, pClientInterfaceInfo y lpwsDLLPath son null, la función no hace nada y devuelve 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