Compartir a través de

Función MprAdminTransportGetInfo (mprapi.h)

  • Artículo

La función MprAdminTransportGetInfo recupera información global, información de interfaz de cliente predeterminada o ambas, para un transporte especificado.

Sintaxis

DWORD MprAdminTransportGetInfo(
  [in]            MPR_SERVER_HANDLE hMprServer,
  [in]            DWORD             dwTransportId,
  [out, optional] LPBYTE            *ppGlobalInfo,
  [out, optional] LPDWORD           lpdwGlobalInfoSize,
  [out, optional] LPBYTE            *ppClientInterfaceInfo,
  [out, optional] LPDWORD           lpdwClientInterfaceInfoSize
);

Parámetros

[in] hMprServer

Maneje al enrutador desde el que se está recuperando la información. Este identificador se obtiene de una llamada anterior a MprAdminServerConnect.

[in] dwTransportId

Valor DWORD que describe el tipo de transporte que se va a recuperar. Los valores aceptables para dwTransportId se enumeran en la tabla siguiente.

Valor Transporte (familia de protocolos)
PID_ATALK Appletalk
PID_IP Protocolo de Internet versión 4
PID_IPX Intercambio de paquetes de Internet
PID_NBF Protocolo de marcos NetBIOS
PID_IPV6 Windows Server 2008 o posterior: Protocolo de Internet versión 6

[out, optional] ppGlobalInfo

Puntero a una variable de puntero. Esta variable apunta a un encabezado de información que recibe información global para este transporte. Use las funciones de encabezado de información para manipular encabezados de información.

Libere esta memoria llamando a MprAdminBufferFree.

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, de la información global del transporte.

[out, optional] ppClientInterfaceInfo

Puntero a una variable de puntero. Esta variable apunta a la información predeterminada de la interfaz de cliente para este transporte. Libere esta memoria llamando a MprAdminBufferFree.

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 de cliente.

[out, optional] lpdwClientInterfaceInfoSize

Puntero a una variable DWORD . Esta variable recibe el tamaño, en bytes, de la información de la interfaz de cliente.

Valor devuelto

Si la función se ejecuta 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_ACCESS_DENIED
 La aplicación que realiza la llamada no tiene privilegios suficientes.
ERROR_INVALID_PARAMETER
 Una de las siguientes condiciones se cumple:
  • El parámetro ppGlobalInfo y el parámetro ppClientInterfaceInfo son NULL.
  • El parámetro ppGlobalInfo no apunta a memoria válida.
  • El parámetro ppClientInterfaceInfo no apunta a memoria válida.
ERROR_NOT_ENOUGH_MEMORY
 Recursos insuficientes para completar la operación.
ERROR_UNKNOWN_PROTOCOL_ID
 El valor dwTransportId no coincide con ningún transporte instalado.

Comentarios

Los parámetros ppGlobalInfo y ppClientInterfaceInfo no pueden ser NULL.

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

Consulte también

MprAdminBufferFree

MprAdminServerConnect

MprAdminTransportSetInfo

Funciones de administración del enrutador

Referencia de administración de enrutadores