Función SnmpCleanup (winsnmp.h)

Artículo
08/27/2023

[SNMP está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use la administración remota de Windows, que es la implementación de Microsoft de WS-Man.]

La función SnmpCleanup informa a la implementación de Microsoft WinSNMP de que la aplicación WinSNMP que realiza la llamada ya no requiere los servicios de la implementación.

Nota Una aplicación WinSNMP debe llamar a la función SnmpCleanup como la última función winSNMP antes de finalizar.

Sintaxis

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es SNMPAPI_SUCCESS. Hasta que la aplicación WinSNMP recupera correctamente la función SnmpStartup , cualquier otra llamada a una función WinSNMP devuelve SNMPAPI_FAILURE, con un código de error extendido de SNMPAPI_NOT_INITIALIZED.

Si se produce un error en la función, el valor devuelto es SNMPAPI_FAILURE, pero la aplicación WinSNMP no necesita volver a intentar la llamada a SnmpCleanup. Para obtener información de error extendida, llame a SnmpGetLastError especificando un valor NULL en su parámetro de sesión . La función SnmpGetLastError puede devolver uno de los siguientes errores.

Código devuelto	Descripción
SNMPAPI_NOT_INITIALIZED	La función SnmpStartup no se completó correctamente.
SNMPAPI_ALLOC_ERROR	Error durante la asignación de memoria.
SNMPAPI_OTHER_ERROR	Error desconocido o indefinido.

Comentarios

Antes de que la aplicación WinSNMP llame a SnmpCleanup, debe llamar a la función SnmpClose una vez para cada sesión que se abra la implementación como resultado de una llamada a la función SnmpCreateSession .

Cuando una aplicación WinSNMP llama a la función SnmpCleanup , la implementación desasigna todos los recursos asignados a la aplicación. Sin embargo, se recomienda que una aplicación WinSNMP libere los recursos específicos que la implementación asigna para ella con la función WinSNMP que corresponde al recurso. Para obtener más información sobre cómo liberar recursos individuales, vea SnmpFreeEntity, SnmpFreeVbl, SnmpFreeDescriptor, SnmpFreeContext y SnmpFreePdu.

Si una aplicación WinSNMP debe realizar una salida de emergencia y llama a SnmpCleanup sin liberar recursos individuales y sin llamar a SnmpClose para cada sesión abierta, la implementación desasigna todos los recursos asignados a la aplicación WinSNMP. Sin embargo, para habilitar esta funcionalidad en la implementación, la aplicación debe seguir llamando a SnmpCleanup.

No se debe llamar a SnmpCleanup cuando el archivo DLL de la aplicación está en proceso de descarga.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winsnmp.h
Library	Wsnmp32.lib
Archivo DLL	Wsnmp32.dll