SnmpFreeDescriptor, fonction (winsnmp.h)

Article
03/13/2024

[SNMP est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Utilisez plutôt Windows Remote Management, qui est l’implémentation Microsoft de WS-Man.]

Une application WinSNMP utilise la fonction SnmpFreeDescriptor pour informer l’implémentation Microsoft WinSNMP qu’elle n’a plus besoin d’accéder à un objet de descripteur. Cette fonction WinSNMP signale à l’implémentation de libérer la mémoire allouée à l’objet de descripteur.

Syntaxe

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

Paramètres

[in] syntax

Spécifie le type de données syntaxique de l’objet de descripteur cible.

[in] descriptor

Pointeur vers une structure smiOPAQUE qui contient l’objet de descripteur cible à libérer.

Valeur retournée

Si la fonction réussit, la valeur de retour est SNMPAPI_SUCCESS.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError en spécifiant une valeur NULL dans son paramètre de session . La fonction SnmpGetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
SNMPAPI_NOT_INITIALIZED	La fonction SnmpStartup ne s’est pas terminée correctement.
SNMPAPI_ALLOC_ERROR	Une erreur s’est produite lors de l’allocation de mémoire.
SNMPAPI_SYNTAX_INVALID	Le paramètre de syntaxe n’est pas valide.
SNMPAPI_OPERATION_INVALID	Le paramètre de descripteur n’est pas valide. Pour plus d’informations, consultez la section Remarques suivante.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

L’implémentation alloue et libère de la mémoire pour les objets de descripteur de sortie avec des longueurs variables. Cette allocation et cette désallocation de mémoire sont limitées à l’implémentation, à l’exception de l’interface que fournit la fonction SnmpFreeDescriptor . Pour plus d’informations, consultez Freeing WinSNMP Descriptors.

L’implémentation retourne le code d’erreur SNMPAPI_OPERATION_INVALID si le paramètre de descripteur spécifie une allocation de mémoire que l’implémentation a libérée lors d’un appel antérieur à SnmpFreeDescriptor. La fonction retourne le même code d’erreur si le paramètre de descripteur spécifie une allocation de mémoire que l’implémentation n’a pas effectuée pour l’application WinSNMP appelante.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winsnmp.h
Bibliothèque	Wsnmp32.lib
DLL	Wsnmp32.dll

Voir aussi

Vue d’ensemble de l’API WinSNMP