Función MprAdminInterfaceGetHandle (mprapi.h)

La función MprAdminInterfaceGetHandle recupera un identificador en una interfaz especificada.

Sintaxis

DWORD MprAdminInterfaceGetHandle(
  [in]  MPR_SERVER_HANDLE hMprServer,
  [in]  LPWSTR            lpwsInterfaceName,
  [out] HANDLE            *phInterface,
  [in]  BOOL              fIncludeClientInterfaces
);

Parámetros

[in] hMprServer

Controle al enrutador en el que se va a ejecutar esta llamada. Obtenga este identificador llamando a MprAdminServerConnect.

[in] lpwsInterfaceName

Puntero a una cadena Unicode terminada en null que especifica el nombre de la interfaz que se va a recuperar.

[out] phInterface

Puntero a una variable HANDLE que recibe un identificador de la interfaz especificada por lpwsInterfaceName.

[in] fIncludeClientInterfaces

Especifica si la función devuelve una interfaz de cliente. Si este parámetro es FALSE, las interfaces de tipo ROUTER_IF_TYPE_CLIENT se omiten en la búsqueda de la interfaz con el nombre especificado por lpwsInterfaceName. Si este parámetro es TRUE y existe una interfaz con el nombre especificado, MprAdminInterfaceGetHandle devuelve un identificador a una interfaz de tipo ROUTER_IF_TYPE_CLIENT. Puesto que es posible que haya varias interfaces de tipo ROUTER_IF_TYPE_CLIENT, el identificador devolvió referencias a la primera interfaz encontrada con el nombre especificado por lpwsInterfaceName.

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.

Requisitos

Consulte también

MprAdminServerConnect

ROUTER_INTERFACE_TYPE

Funciones de administración del enrutador

Referencia de administración de enrutadores