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

Статья
08/27/2023

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

Функция SnmpStrToContext WinSNMP возвращает дескриптор для сведений контекста SNMP, относящихся к реализации Microsoft WinSNMP. Дескриптор — это допустимое значение, которое приложение WinSNMP может использовать в качестве параметра контекста при вызове функций SnmpSendMsg и SnmpRegister .

Синтаксис

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

Параметры

[in] session

Обработка в сеансе WinSNMP.

[in] string

Указатель на структуру smiOCTETS , содержащую строку для интерпретации. Строка может идентифицировать коллекцию управляемых объектов или строку сообщества.

Текущее значение режима преобразования сущности и контекста определяет, как SnmpStrToContext интерпретирует структуру входной строки, как показано в следующей таблице.

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

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

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

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

Код возврата	Описание
SNMPAPI_NOT_INITIALIZED	Не удалось выполнить функцию SnmpStartup .
SNMPAPI_ALLOC_ERROR	Ошибка при выделении памяти.
SNMPAPI_SESSION_INVALID	Недопустимый параметр сеанса .
SNMPAPI_CONTEXT_INVALID	Недопустимый формат строкового параметра. Например, элемент len или элемент ptr структуры smiOCTETS , на который указывает строковый параметр, имеет значение NULL.
SNMPAPI_CONTEXT_UNKNOWN	Значение, на которое ссылается строковый параметр, не существует.
SNMPAPI_OTHER_ERROR	Произошла неизвестная или неопределенная ошибка.

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

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

Приложение WinSNMP должно освободить память, связанную с элементом ptr структуры smiOCTETS , на которую указывает строковый параметр. Это связано с тем, что приложение определяет и выделяет ресурсы. Например, если приложение выделило ресурсы с помощью вызова функции GlobalAlloc , оно должно использовать функцию GlobalFree для освобождения ресурсов. Дополнительные сведения см. в разделе Освобождение дескрипторов WinSNMP.

Требования


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