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


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

Функция MprConfigGetFriendlyName возвращает понятное имя интерфейса, соответствующее указанному имени GUID.

Синтаксис

DWORD MprConfigGetFriendlyName(
  [in]  HANDLE hMprConfig,
  [in]  PWSTR  pszGuidName,
  [out] PWCHAR pszBuffer,
  [in]  DWORD  dwBufferSize
);

Параметры

[in] hMprConfig

Обработка конфигурации маршрутизатора. Получите этот дескриптор, вызвав MprConfigServerConnect.

[in] pszGuidName

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

[out] pszBuffer

Указатель на буфер, получающий понятное имя интерфейса.

[in] dwBufferSize

Указывает размер (в байтах) буфера, на который указывает pszBuffer.

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

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

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

Значение Значение
ERROR_BUFFER_OVERFLOW
Буфер, на который указывает pszBuffer , недостаточно велик для хранения возвращенного имени GUID.
ERROR_INVALID_PARAMETER
Один из следующих параметров hMprConfig, pszGuidName или pszBuffer имеет значение NULL.
ERROR_NOT_FOUND
Не найдено имя GUID, соответствующее указанному понятному имени.
 
 

Комментарии

Дополнительные сведения см. в разделе Как избежать переполнения буфера.

Требования

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

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

Предотвращение переполнения буфера

MprConfigGetGuidName

MprConfigServerConnect

Функции конфигурации маршрутизатора

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