Função SnmpCleanup (winsnmp.h)

Artigo
08/27/2023

[O SNMP está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. Em vez disso, use o Gerenciamento Remoto do Windows, que é a implementação da Microsoft do WS-Man.]

A função SnmpCleanup informa à implementação do Microsoft WinSNMP que o aplicativo WinSNMP de chamada não requer mais os serviços da implementação.

Nota Um aplicativo WinSNMP deve chamar a função SnmpCleanup como a última função WinSNMP antes de ser encerrada.

Sintaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

Valor retornado

Se a função for bem-sucedida, o valor retornado será SNMPAPI_SUCCESS. Até que o aplicativo WinSNMP lembre com êxito a função SnmpStartup , qualquer outra chamada para uma função WinSNMP retornará SNMPAPI_FAILURE, com um código de erro estendido de SNMPAPI_NOT_INITIALIZED.

Se a função falhar, o valor retornado será SNMPAPI_FAILURE, mas o aplicativo WinSNMP não precisará repetir a chamada para SnmpCleanup. Para obter informações de erro estendidas, chame SnmpGetLastError especificando um valor NULL em seu parâmetro de sessão . A função SnmpGetLastError pode retornar um dos erros a seguir.

Código de retorno	Descrição
SNMPAPI_NOT_INITIALIZED	A função SnmpStartup não foi concluída com êxito.
SNMPAPI_ALLOC_ERROR	Ocorreu um erro durante a alocação de memória.
SNMPAPI_OTHER_ERROR	Ocorreu um erro desconhecido ou indefinido.

Comentários

Antes que o aplicativo WinSNMP chame SnmpCleanup, ele deve chamar a função SnmpClose uma vez para cada sessão que a implementação abrir como resultado de uma chamada para a função SnmpCreateSession .

Quando um aplicativo WinSNMP chama a função SnmpCleanup , a implementação desaloca todos os recursos alocados para o aplicativo. No entanto, é recomendável que um aplicativo WinSNMP libere os recursos específicos que a implementação aloca para ele com a função WinSNMP que corresponde ao recurso. Para obter informações adicionais sobre como liberar recursos individuais, consulte SnmpFreeEntity, SnmpFreeVbl, SnmpFreeDescriptor, SnmpFreeContext e SnmpFreePdu.

Se um aplicativo WinSNMP precisar executar uma saída de emergência e chamar SnmpCleanup sem liberar recursos individuais e sem chamar SnmpClose para cada sessão aberta, a implementação desalocará todos os recursos alocados para o aplicativo WinSNMP. No entanto, para habilitar essa funcionalidade na implementação, o aplicativo ainda deve chamar SnmpCleanup.

SnmpCleanup não deve ser chamado quando a DLL do aplicativo está em processo de descarregamento.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winsnmp.h
Biblioteca	Wsnmp32.lib
DLL	Wsnmp32.dll