Función MprConfigTransportSetInfo (mprapi.h)

Artículo
03/15/2023

La función MprConfigTransportSetInfo cambia la configuración del protocolo de transporte especificado en la configuración del enrutador especificado.

Sintaxis

DWORD MprConfigTransportSetInfo(
  [in]           HANDLE hMprConfig,
  [in]           HANDLE hRouterTransport,
  [in, optional] LPBYTE pGlobalInfo,
  [in, optional] DWORD  dwGlobalInfoSize,
  [in, optional] LPBYTE pClientInterfaceInfo,
  [in, optional] DWORD  dwClientInterfaceInfoSize,
  [in, optional] LPWSTR lpwsDLLPath
);

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á actualizando. Obtenga este identificador llamando a MprConfigTransportCreate, MprConfigTransportGetHandle o MprConfigTransportEnum. Los tipos de protocolo de transporte admitidos aparecen en Identificadores de transporte.

[in, optional] pGlobalInfo

Puntero a un encabezado de información que especifica información global para el protocolo de transporte. El administrador de enrutadores del transporte interpreta esta información. Use las funciones de encabezado de información para manipular encabezados de información.

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro.

[in, optional] dwGlobalInfoSize

Especifica el tamaño, en bytes, de los datos a los que apunta pGlobalInfo. Si la aplicación que llama especifica NULL para pGlobalInfo, la aplicación que llama debe especificar cero para este parámetro.

[in, optional] pClientInterfaceInfo

Puntero a un encabezado de información que especifica la información de interfaz predeterminada para los enrutadores de cliente. La información se usa para configurar interfaces dinámicas para enrutadores cliente para este transporte. Use las funciones de encabezado de información para manipular encabezados de información.

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro.

[in, optional] dwClientInterfaceInfoSize

Especifica el tamaño, en bytes, de los datos a los que apunta pClientInterfaceInfo. Si la aplicación que llama especifica NULL para pClientInterfaceInfo, la aplicación que llama debe especificar cero para este parámetro.

[in, optional] lpwsDLLPath

Puntero a una cadena Unicode terminada en null que especifica el nombre del archivo DLL del administrador de enrutadores para el transporte especificado.

Este parámetro es opcional; la aplicación que llama puede especificar NULL para este parámetro.

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	El parámetro hMprConfig es NULL, el parámetro hRouterTransport es NULL o ambos son 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.
Otros	Use FormatMessage para recuperar el mensaje de error del sistema que corresponde al código de error devuelto.

Comentarios

Use MprConfigTransportSetInfo para establecer la información global del transporte, la información de interfaz predeterminada o el nombre del archivo DLL del administrador de enrutadores para el transporte.

MprConfigTransportSetInfo intenta establecer los elementos en el orden en que aparecen en la lista de parámetros:

Información global.
Información de interfaz predeterminada para enrutadores de cliente.
Nombre dll del administrador de enrutadores.

Si MprConfigTransportSetInfo no puede establecer ninguno de los elementos, se devuelve inmediatamente sin intentar establecer los elementos restantes.

Si los parámetros pGlobalInfo, pClientInterfaceInfo y lpwsDLLPath son null, la función no hace nada, devolviendo un valor de NO_ERROR.

Requisitos

Requisito	Value
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