Функция MprAdminInterfaceGetHandle (mprapi.h)

Статья
08/24/2023

Функция MprAdminInterfaceGetHandle извлекает дескриптор в указанный интерфейс.

Синтаксис

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

Параметры

[in] hMprServer

Дескриптор маршрутизатора, на котором выполняется этот вызов. Получите этот дескриптор, вызвав MprAdminServerConnect.

[in] lpwsInterfaceName

Указатель на строку Юникода, завершающуюся значением NULL, которая указывает имя извлекаемого интерфейса.

[out] phInterface

Указатель на переменную HANDLE , которая получает дескриптор интерфейса, заданного lpwsInterfaceName.

[in] fIncludeClientInterfaces

Указывает, возвращает ли функция клиентский интерфейс. Если этот параметр имеет значение FALSE, интерфейсы типа ROUTER_IF_TYPE_CLIENT игнорируются при поиске интерфейса с именем, указанным в lpwsInterfaceName. Если этот параметр имеет значение TRUE и существует интерфейс с указанным именем, MprAdminInterfaceGetHandle возвращает дескриптор в интерфейс типа ROUTER_IF_TYPE_CLIENT. Так как существует несколько интерфейсов типа ROUTER_IF_TYPE_CLIENT, дескриптор вернул ссылку на первый найденный интерфейс с именем, указанным в lpwsInterfaceName.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращается один из следующих кодов ошибок.

Значение	Значение
ERROR_ACCESS_DENIED	Вызывающее приложение не имеет достаточных привилегий.
ERROR_NO_SUCH_INTERFACE	Не существует интерфейса с именем, указанным в lpwsInterfaceName.
RPC_S_INVALID_BINDING	Дескриптор, передаваемый серверу, имеет значение NULL.
RPC_X_NULL_REF_POINTER	lpwsInterfaceName имеет значение NULL.

Требования


Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	mprapi.h
Библиотека	Mprapi.lib
DLL	Mprapi.dll

См. также раздел

MprAdminServerConnect

ROUTER_INTERFACE_TYPE

Функции администрирования маршрутизатора

Справочник по управлению маршрутизаторами

Поделиться через