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

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

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

Синтаксис

SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
  [in] HSNMP_SESSION session,
  [in] smiINT32      reqId
);

Параметры

[in] session

Обработка сеанса WinSNMP, отправившего сообщение запроса SNMP (PDU) для отмены.

[in] reqId

Задает уникальное числовое значение, определяющее интересующее PDU. Этот параметр должен соответствовать идентификатору запроса (request_id) параметра PDU , указанного в первоначальном вызове функции SnmpSendMsg приложения.

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

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

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

Код возврата Описание
SNMPAPI_SESSION_INVALID
Недопустимый параметр сеанса .
SNMPAPI_PDU_INVALID
Параметр reqId не определяет неоплаченное сообщение для указанного сеанса.
SNMPAPI_NOT_INITIALIZED
Не удалось выполнить функцию SnmpStartup .
SNMPAPI_ALLOC_ERROR
Ошибка при выделении памяти.
SNMPAPI_OTHER_ERROR
Произошла неизвестная или неопределенная ошибка.

Комментарии

Вызов функции SnmpCancelMsg эквивалентен вызову функции SnmpSetRetransmitMode для определенного SNMP-сообщения с режимом повторной передачи, равным SNMPAPI_OFF.

Дополнительные сведения см. в разделах Отмена повторной передачи и Управление политикой повторной передачи.

Требования

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

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

SnmpSendMsg

SnmpSetRetransmitMode

Функции WinSNMP

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