Функции WinSNMP

  • Статья

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

Функции, используемые с WinSNMP, делятся на следующие функциональные группы. Ниже приведен алфавитный список.

Функции связи WinSNMP

Функции связи WinSNMP предоставляют интерфейс между вызывающим приложением WinSNMP и реализацией Microsoft WinSNMP. Реализация обрабатывает обмен данными между приложением и другими сущностями управления.

Функция Описание
SnmpCancelMsg Запрашивает, чтобы реализация Microsoft WinSNMP отменяла попытки повторной передачи и уведомления об истечении времени ожидания для сообщения запроса SNMP.
SnmpCleanup Сообщает реализации, что приложение отключается и больше не требует выделенных ресурсов.
SnmpCleanupEx Выполняет очистку при отсутствии невыполненных успешных вызовов SnmpStartup или SnmpStartupEx в приложении WinSNMP.
SnmpClose Позволяет реализации освободить ресурсы, связанные с сеансом, и закрыть механизмы связи.
SnmpCreateSession Запрашивает реализацию для открытия сеанса WinSNMP и выделения ресурсов и механизмов связи. При разработке новых приложений WinSNMP рекомендуется вызывать функцию SnmpCreateSession , чтобы открыть сеанс WinSNMP вместо вызова функции SnmpOpen .
SnmpListen Регистрирует или отменяет регистрацию приложения WinSNMP в качестве агента SNMP.
SnmpOpen Запрашивает реализацию для открытия сеанса WinSNMP и выделения ресурсов и механизмов связи. При разработке новых приложений WinSNMP рекомендуется вызывать функцию SnmpCreateSession , чтобы открыть сеанс WinSNMP вместо вызова функции SnmpOpen .
SnmpRecvMsg Возвращает сообщения SNMP и необработанные данные ловушки и уведомления.
SnmpRegister Сообщает реализации, что приложение должно зарегистрировать или отменить регистрацию для ловушек и уведомлений.
SnmpSendMsg Запрашивает, чтобы реализация передала единицу данных протокола.
SnmpStartup Уведомляет реализацию о необходимости выполнения процедур инициализации для приложения. Приложение должно успешно вызвать функцию SnmpStartup , прежде чем вызывать любую другую функцию WinSNMP.
SnmpStartupEx Уведомляет реализацию Microsoft WinSNMP о том, что приложению WinSNMP требуются службы реализации. SnmpStartupEx обеспечивает поддержку нескольких независимых программных модулей, использующих WinSNMP в одном приложении.
SNMPAPI_CALLBACK Уведомляет сеанс WinSNMP о доступности сообщения SNMP или асинхронного события. Примечание: Эта функция обратного вызова применяется только к сеансам, открытым в результате вызова функции SnmpCreateSession .

Функции сущности и контекста WinSNMP

Функции сущности и контекста WinSNMP позволяют приложению WinSNMP указать понятные имена для сущностей и контекстов SNMP. Реализация Microsoft WinSNMP преобразует имя в компоненты SNMPv1 или SNMPv2C, используя базу данных реализации.

Функция Описание
SnmpContextToStr Возвращает строку, определяющую контекст SNMP (набор ресурсов управляемого объекта).
SnmpEntityToStr Возвращает строку, определяющую сущность управления SNMP.
SnmpFreeContext Освобождает ресурсы, выделенные функцией SnmpStrToContext для контекста SNMP.
SnmpFreeEntity Освобождает ресурсы, выделенные функцией SnmpStrToEntity для объекта управления SNMP.
SnmpSetPort Изменяет порт, назначенный целевой сущности SNMP.
SnmpStrToContext Возвращает дескриптор для сведений контекста SNMP, относящихся к реализации.
SnmpStrToEntity Возвращает дескриптор для сведений сущности управления SNMP, относящихся к реализации.

Функции базы данных WinSNMP

Функции базы данных WinSNMP предоставляют приложению WinSNMP доступ к текущим параметрам в хранилище административной информации реализации Microsoft WinSNMP. Эти функции позволяют изменять режим повторной передачи, а также режим преобразования сущностей и контекста. Функции базы данных также предоставляют приложению возможность управлять значениями времени ожидания и количества повторных попыток.

Функция Описание
SnmpGetRetransmitMode Возвращает текущее значение режима повторной передачи.
SnmpGetRetry Возвращает значение счетчика повторных попыток (в единицах) для повторной передачи запросов сообщений SNMP.
SnmpGetTimeout Возвращает значение времени ожидания (в сотых секундах) для передачи запросов сообщений SNMP.
SnmpGetTranslateMode Возвращает текущее значение для режима преобразования сущности и контекста.
SnmpGetVendorInfo Извлекает сведения, определяющие поставщика WinSNMP.
SnmpSetRetransmitMode Изменяет режим повторной передачи.
SnmpSetRetry Изменяет значение счетчика повторных попыток для повторной передачи запросов сообщений SNMP.
SnmpSetTimeout Изменяет значение времени ожидания для передачи запросов сообщений SNMP.
SnmpSetTranslateMode Изменяет режим преобразования сущности и контекста.

Функции PDU WinSNMP

Функции PDU WinSNMP позволяют приложениям WinSNMP извлекать и обновлять элементы данных (или поля) PDU. Сюда входят PKU, возвращаемые вызовом функции SnmpRecvMsg или SnmpDecodeMsg . Функции PDU также создают PDU для использования в функциях SnmpSendMsg и SnmpEncodeMsg .

Функция Описание
SnmpCreatePdu Создает и инициализирует единицу данных протокола SNMP.
SnmpDuplicatePdu Дублирует единицу данных протокола SNMP.
SnmpFreePdu Освобождает ресурсы, связанные с единицей данных протокола SNMP, созданной функцией SnmpCreatePdu или SnmpDuplicatePdu .
SnmpGetPduData Возвращает выбранные элементы данных из указанной единицы данных протокола SNMP.
SnmpSetPduData Обновления выбранные элементы данных в указанной единице данных протокола SNMP.

Функции служебной программы WinSNMP

Служебные функции WinSNMP позволяют приложению WinSNMP управлять объектами и сообщениями SNMP в интерфейсе WinSNMP.

Функция Описание
SnmpDecodeMsg Декодирует закодированное или сериализованное SNMP-сообщение в составляющие его компоненты.
SnmpEncodeMsg Создает закодированное SNMP-сообщение.
SnmpFreeDescriptor Сигнал реализации Microsoft WinSNMP о том, что она должна освободить память, выделенную для определенного дескриптора.
SnmpGetLastError Возвращает значение кода последней ошибки для последней операции SNMP.
SnmpOidCompare Сравнивает два идентификатора объектов SNMP.
SnmpOidCopy Копирует идентификатор объекта SNMP.
SnmpOidToStr Преобразует внутреннее двоичное представление идентификатора объекта SNMP в формат его пунктирной числовой строки.
SnmpStrToOid Преобразует формат пунктирной числовой строки идентификатора объекта SNMP во внутреннее двоичное представление.

Функции привязки переменных WinSNMP

Функции привязки переменных WinSNMP позволяют приложениям WinSNMP создавать списки привязки переменных и управлять ими, а также включать их в PKU.

Функция Описание
SnmpCountVbl Перечисляет записи привязки переменных в указанном списке привязки переменных.
SnmpCreateVbl Создает новый список привязок переменных.
SnmpDeleteVb Удаляет запись привязки переменной из списка привязки переменных.
SnmpDuplicateVbl Копирует список привязок переменных.
SnmpFreeVbl Освобождает ресурсы для списка привязок переменных, выделенного ранее функцией SnmpCreateVbl или SnmpDuplicateVbl .
SnmpGetVb Извлекает сведения из указанной записи привязки переменной.
SnmpSetVb Изменяет записи привязки переменных в списке привязки переменных; добавляет новые записи привязки переменных к существующему списку привязки переменных.

Алфавитный список функций WinSNMP