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

Статья
08/27/2023

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

Функция WinSNMP SnmpContextToStr возвращает строку, определяющую контекст SNMP, который представляет собой набор ресурсов управляемого объекта. Функция возвращает строку в структуре smiOCTETS .

Синтаксис

SNMPAPI_STATUS SNMPAPI_CALL SnmpContextToStr(
  [in]  HSNMP_CONTEXT context,
  [out] smiLPOCTETS   string
);

Параметры

[in] context

Обрабатывайте интересующий контекст SNMP.

[out] string

Указатель на структуру smiOCTETS для получения строки, определяющей интересующий контекст. Строка может содержать байт, завершающий значение NULL.

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

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

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

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

Текущий параметр режима преобразования сущности и контекста определяет тип возвращаемой строки вывода SnmpContextToStr . Дополнительные сведения см. в разделе Настройка режима преобразования сущностей и контекста.

Приложение WinSNMP должно предоставить адрес допустимой структуры smiOCTETS для строкового параметра. Если функция SnmpContextToStr завершается успешно, реализация Microsoft WinSNMP инициализирует элементы len и ptr структуры. Приложение WinSNMP должно вызывать функцию SnmpFreeDescriptor , чтобы реализация могла освободить ресурсы для этих членов.

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

Если режим преобразования сущности и контекста SNMPAPI_UNTRANSLATED_V1 или SNMPAPI_UNTRANSLATED_V2, реализация также возвращает строку сообщества SNMP.

Требования


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

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

SnmpFreeDescriptor

Функции WinSNMP

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

smiOCTETS

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