Функция SnmpGetRetry (winsnmp.h)
[SNMP доступен для использования в операционных системах, указанных в разделе Требования. В последующих версиях он может быть изменен или недоступен. Вместо этого используйте удаленное управление Windows, которое является реализацией WS-Man майкрософт.]
Функция SnmpGetRetry WinSNMP возвращает значение счетчика повторных попыток в единицах для повторной передачи запросов сообщений SNMP. Количество повторных попыток применяется к вызовам, которые приложение WinSNMP выполняет к функции SnmpSendMsg для указанной сущности управления.
Синтаксис
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetRetry(
[in] HSNMP_ENTITY hEntity,
[out] smiLPUINT32 nPolicyRetry,
[out] smiLPUINT32 nActualRetry
);
Параметры
[in] hEntity
Обработка целевого объекта управления, который представляет интерес.
[out] nPolicyRetry
Указатель на длинную целочисленную переменную без знака для получения значения счетчика повторных попыток для указанной сущности управления. Это значение, которое реализация Microsoft WinSNMP хранит в базе данных. Если сведения, возвращаемые в этом параметре, не требуются, nPolicyRetry должен быть указателем NULL .
[out] nActualRetry
Указатель на длинную целочисленную переменную без знака, чтобы получить последнее фактическое или предполагаемое число повторных попыток для конечной сущности, как сообщает реализация. Если сведения, возвращаемые в этом параметре, не требуются, nActualRetry должен быть указателем NULL . Если этот параметр является допустимым указателем, функция возвращает значение 0. Дополнительные сведения см. в следующем разделе Примечаний.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет SNMPAPI_SUCCESS.
Если функция завершается сбоем, возвращаемое значение SNMPAPI_FAILURE. Чтобы получить расширенные сведения об ошибке, вызовите SnmpGetLastError , указав значение NULL в параметре сеанса . Функция SnmpGetLastError может возвращать одну из следующих ошибок.
Код возврата | Описание |
---|---|
|
Не удалось выполнить функцию SnmpStartup . |
|
Ошибка при выделении памяти. |
|
Недопустимый параметр hEntity . |
|
Параметры nPolicyRetry и nActualRetry имеют значение NULL. Операция не была выполнена. |
|
Произошла неизвестная или неопределенная ошибка. |
Комментарии
Обычно приложение WinSNMP, а не приложение агента, вызывает функцию SnmpGetRetry .
Приложение WinSNMP может изменить значение счетчика повторных попыток с помощью вызова функции SnmpSetRetry .
Приложение WinSNMP может отслеживать значение параметра nActualRetry и сравнивать его со значением параметра nPolicyRetry для оптимизации производительности передачи. Дополнительные сведения см. в разделах Сведения о повторной отправке и Управление политикой повторной передачи.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
Целевая платформа | Windows |
Header | winsnmp.h |
Библиотека | Wsnmp32.lib |
DLL | Wsnmp32.dll |