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

Статья
03/13/2024

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

Функция WinSNMP SnmpStrToEntity возвращает дескриптор сведений о сущности управления SNMP, относящееся к реализации Microsoft WinSNMP.

Синтаксис

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

Параметры

[in] session

Дескриптор сеанса WinSNMP.

[in] string

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

Режим преобразования сущности/контекста	Значение
SNMPAPI_TRANSLATED	Реализация интерпретирует строковый параметр как понятное имя. Реализация преобразует имя в компоненты SNMPv1 или SNMPv2C, используя базу данных реализации.
SNMPAPI_UNTRANSLATED_V1	Реализация интерпретирует строковый параметр как литеральный адрес транспорта SNMP.
SNMPAPI_UNTRANSLATED_V2	Реализация интерпретирует строковый параметр как литеральный адрес транспорта SNMP.

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

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

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

Код возврата	Описание
SNMPAPI_NOT_INITIALIZED	Функция SnmpStartup не была успешно завершена.
SNMPAPI_ALLOC_ERROR	Произошла ошибка при выделении памяти.
SNMPAPI_SESSION_INVALID	Недопустимый параметр сеанса .
SNMPAPI_ENTITY_UNKNOWN	Недопустимая строка сущности.
SNMPAPI_OTHER_ERROR	Произошла неизвестная или неопределенная ошибка.

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

Приложение WinSNMP должно вызывать функцию SnmpFreeEntity , чтобы освободить дескриптор сущности, выделенный функцией SnmpStrToEntity . Дополнительные сведения см. в статье Основные понятия Управление данными WinSNMP.

Функция SnmpStrToEntity возвращает допустимый дескриптор сущности, который приложение WinSNMP может использовать в качестве параметра srcEntity или dstEntity в нескольких функциях WinSNMP. К этим функциям относятся функции SnmpSendMsg, SnmpRecvMsg, SnmpRegister, SnmpEncodeMsg и SnmpDecodeMsg .

Реализация возвращает текущую сущность и режим преобразования контекста в параметре nTranslateMode функции SnmpStartup . Приложение WinSNMP может изменить параметр режима преобразования сущности и контекста с помощью вызова функции SnmpSetTranslateMode .

Требования

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