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

Статья
08/27/2023

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

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

Примечание Приложение WinSNMP должно вызвать функцию SnmpCleanup в качестве последней функции WinSNMP перед завершением.

Синтаксис

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

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

Если функция выполнена успешно, возвращаемое значение будет SNMPAPI_SUCCESS. Пока приложение WinSNMP не будет успешно вызывать функцию SnmpStartup , любой другой вызов функции WinSNMP возвращает SNMPAPI_FAILURE с расширенным кодом ошибки SNMPAPI_NOT_INITIALIZED.

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

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

Прежде чем приложение WinSNMP вызовет SnmpCleanup, оно должно вызывать функцию SnmpClose один раз для каждого сеанса, который открывается реализацией в результате вызова функции SnmpCreateSession .

Когда приложение WinSNMP вызывает функцию SnmpCleanup , реализация освобождает все ресурсы, выделенные приложению. Однако рекомендуется, чтобы приложение WinSNMP освободило определенные ресурсы, выделенные для него реализацией, с помощью функции WinSNMP, соответствующей ресурсу. Дополнительные сведения об освобождении отдельных ресурсов см. в разделах SnmpFreeEntity, SnmpFreeVbl, SnmpFreeDescriptor, SnmpFreeContext и SnmpFreePdu.

Если приложение WinSNMP должно выполнить аварийный выход и оно вызывает SnmpCleanup без освобождения отдельных ресурсов и вызова SnmpClose для каждого открытого сеанса, реализация освобождает все ресурсы, выделенные приложению WinSNMP. Тем не менее, чтобы включить эту функцию в реализации, приложение должно по-прежнему вызывать SnmpCleanup.

SnmpCleanup не следует вызывать, когда библиотека DLL приложения находится в процессе выгрузки.

Требования


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