Fonction SnmpCancelMsg (winsnmp.h)

Article
03/04/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. Au lieu de cela, utilisez La gestion à distance Windows, qui est l’implémentation Microsoft de WS-Man.]

Une application WinSNMP appelle la fonction SnmpCancelMsg pour demander que l’implémentation de Microsoft WinSNMP annule les tentatives de retransmission et les notifications de délai d’attente pour un message de demande SNMP. La fonction SnmpCancelMsg est un élément de l’API WinSNMP, version 2.0.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
  [in] HSNMP_SESSION session,
  [in] smiINT32      reqId
);

Paramètres

[in] session

Gérez la session WinSNMP qui a envoyé le message de demande SNMP (PDU) à annuler.

[in] reqId

Spécifie une valeur numérique unique qui identifie la PDU d’intérêt. Ce paramètre doit correspondre à l’identificateur de demande (request_id) du paramètre PDU spécifié dans l’appel initial de l’application à la fonction SnmpSendMsg .

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. La fonction SnmpGetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
SNMPAPI_SESSION_INVALID	Le paramètre de session n’est pas valide.
SNMPAPI_PDU_INVALID	Le paramètre reqId n’identifie pas de message en attente pour la session spécifiée.
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_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

L’appel de la fonction SnmpCancelMsg revient à appeler la fonction SnmpSetRetransmitMode , pour un message SNMP spécifique, avec le mode de retransmission égal à SNMPAPI_OFF.

Pour plus d’informations, consultez Annulation de la retransmission et Gestion de la stratégie de retransmission.

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

SnmpSendMsg

SnmpSetRetransmitMode

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP

Partager via