SnmpExtensionInit, fonction (snmp.h)

Article
08/26/2023

[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.]

Le service SNMP Microsoft appelle la fonction SnmpExtensionInit pour initialiser la DLL de l’agent d’extension SNMP. Cette fonction est un élément de l’API de l’agent d’extension SNMP.

Syntaxe

BOOL SNMP_FUNC_TYPE SnmpExtensionInit(
  [in]  DWORD               dwUptimeReference,
  [out] HANDLE              *phSubagentTrapEvent,
  [out] AsnObjectIdentifier *pFirstSupportedRegion
);

Paramètres

[in] dwUptimeReference

Spécifie une référence de délai zéro pour l’agent d’extension.

Note Les agents d’extension doivent ignorer ce paramètre. La DLL de l’agent d’extension SNMP doit utiliser la fonction SnmpSvcGetUptime pour récupérer le nombre de centisecondes que le service SNMP a exécuté. Pour plus d'informations, consultez la section Notes qui suit.

[out] phSubagentTrapEvent

Pointeur vers un handle d’événement que l’agent d’extension revient au service SNMP. Ce handle est utilisé pour informer le service que l’agent d’extension a une ou plusieurs interruptions à envoyer. Pour plus d’informations sur l’allocation et la désaffectation du handle d’événement, consultez la section Notes suivante.

[out] pFirstSupportedRegion

Pointeur vers une structure AsnObjectIdentifier pour recevoir la première sous-arborescence MIB prise en charge par l’agent d’extension. Pour plus d’informations sur l’allocation et la désaffectation de ressources pour cette structure, consultez la section Remarques suivante.

L’agent d’extension peut inscrire des sous-arborescences MIB supplémentaires en implémentant la fonction de point d’entrée SnmpExtensionInitEx .

Valeur retournée

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

Si la fonction échoue, la valeur de retour est FALSE.

Remarques

Les agents d’extension doivent ignorer le paramètre dwUptimeReference . Au lieu de cela, ils doivent appeler la fonction SnmpSvcGetUptime pour récupérer le nombre de centisecondes que le service SNMP Microsoft a été en cours d’exécution. Étant donné que le paramètre dwUptimeReference stocke le temps écoulé sous la forme d’une valeur DWORD en millisecondes, le temps peut être renvoyé à zéro et refléter un intervalle de temps inexact.

L’agent d’extension informe le service SNMP qu’il doit envoyer une ou plusieurs interruptions en définissant le handle d’événement passé dans le paramètre phSubagentTrapEvent à l’état signalé. Une fois cet événement signalé, le service SNMP appelle à plusieurs reprises le point d’entrée SnmpExtensionTrap de l’agent d’extension jusqu’à ce que la fonction retourne la valeur FALSE. Cela indique que l’agent d’extension n’a plus d’interruptions à envoyer. Si l’agent d’extension ne génère pas d’interruptions, le paramètre phSubagentTrapEvent doit retourner une valeur NULL.

L’agent d’extension SNMP doit allouer et libérer des ressources pour le handle d’événement d’interruption. Lorsque le service SNMP appelle la fonction SnmpExtensionInit , l’agent d’extension doit appeler la fonction CreateEvent pour allouer le handle d’événement. L’agent d’extension transmet le handle au service SNMP dans le paramètre phSubagentTrapEvent . Lorsque le service SNMP appelle la fonction SnmpExtensionClose , l’agent d’extension doit libérer des ressources pour le handle d’événement d’interruption.

Le service SNMP effectue une copie de la structure AsnObjectIdentifier que l’agent d’extension retourne dans le paramètre pFirstSupportedRegion . L’agent d’extension doit allouer et libérer les ressources associées à la structure d’origine. Il peut le faire lorsque le service SNMP appelle la fonction SnmpExtensionClose .

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	snmp.h