Função SnmpFreeDescriptor (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.]

Um aplicativo WinSNMP usa a função SnmpFreeDescriptor para informar à implementação do Microsoft WinSNMP que ele não requer mais acesso a um objeto descritor. Essa função WinSNMP sinaliza a implementação para liberar a memória alocada para o objeto descritor.

Sintaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpFreeDescriptor(
  [in] smiUINT32   syntax,
  [in] smiLPOPAQUE descriptor
);

Parâmetros

[in] syntax

Especifica o tipo de dados de sintaxe do objeto descritor de destino.

[in] descriptor

Ponteiro para uma estrutura smiOPAQUE que contém o objeto descritor de destino a ser liberado.

Retornar valor

Se a função for bem-sucedida, o valor retornado será SNMPAPI_SUCCESS.

Se a função falhar, o valor retornado será SNMPAPI_FAILURE. 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_SYNTAX_INVALID	O parâmetro de sintaxe é inválido.
SNMPAPI_OPERATION_INVALID	O parâmetro descritor é inválido. Para obter informações adicionais, consulte a seção Comentários a seguir.
SNMPAPI_OTHER_ERROR	Ocorreu um erro desconhecido ou indefinido.

Comentários

A implementação aloca e desaloca memória para objetos descritores de saída com comprimentos variáveis. Essa alocação de memória e desalocação são restritas à implementação, exceto pela interface que a função SnmpFreeDescriptor fornece. Para obter informações adicionais, consulte Freeing WinSNMP Descriptors.

A implementação retornará o código de erro SNMPAPI_OPERATION_INVALID se o parâmetro descritor especificar uma alocação de memória que a implementação liberou em uma chamada anterior para SnmpFreeDescriptor. A função retornará o mesmo código de erro se o parâmetro descritor especificar uma alocação de memória que a implementação não fez para o aplicativo WinSNMP de chamada.

Requisitos

Requisito	Valor
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