Функция SnmpEntityToStr (winsnmp.h)

Статья
08/27/2023

[SNMP доступен для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Вместо этого используйте удаленное управление Windows, которое является реализацией WS-Man майкрософт.]

Функция SnmpEntityToStr WinSNMP возвращает строку, идентифицирующая сущность управления SNMP.

Синтаксис

SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
  [in]  HSNMP_ENTITY entity,
  [in]  smiUINT32    size,
  [out] LPSTR        string
);

Параметры

[in] entity

Дескриптор для интересующей сущности управления SNMP.

[in] size

Задает размер (в байтах) буфера, на который указывает строковый параметр. Приложение WinSNMP должно выделить буфер, достаточно большой для размещения выходной строки.

[out] string

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

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

Если функция выполняется успешно, возвращаемое значение — это количество байтов, включая завершающий байт NULL, возвращаемый SnmpEntityToStr в строковом буфере. Это значение может быть меньше или равно значению параметра size , но не может быть больше.

Если функция завершается сбоем, возвращаемое значение будет SNMPAPI_FAILURE. Чтобы получить расширенные сведения об ошибке, вызовите SnmpGetLastError. Функция SnmpGetLastError может возвращать одну из следующих ошибок.

Код возврата	Описание
SNMPAPI_NOT_INITIALIZED	Функция SnmpStartup не была успешно завершена.
SNMPAPI_ALLOC_ERROR	Произошла ошибка при выделении памяти.
SNMPAPI_ENTITY_INVALID	Недопустимый параметр сущности .
SNMPAPI_OUTPUT_TRUNCATED	Длина выходного буфера недостаточна.
SNMPAPI_OTHER_ERROR	Произошла неизвестная или неопределенная ошибка.

Текущее значение режима преобразования сущности и контекста определяет тип возвращаемой строки вывода SnmpEntityToStr . Дополнительные сведения см. в разделах Поддержка строк IPX-адресов в WinSNMP и Настройка режима преобразования сущностей и контекста.

Если сущность и режим преобразования контекста SNMPAPI_TRANSLATED, а в базе данных реализации существует запись, реализация возвращает связанное понятное имя сущности управления. Если для сущности управления не существует записи, SnmpEntityToStr возвращает литеральный транспортный адрес SNMP объекта управления.

Если режим преобразования сущности и контекста SNMPAPI_UNTRANSLATED_V1 или SNMPAPI_UNTRANSLATED_V2, реализация Microsoft WinSNMP также возвращает литеральный адрес транспорта SNMP для объекта управления.

Требования

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

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

SnmpStrToEntity

Функции WinSNMP

Общие сведения об API WinSNMP

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