SnmpOpen, fonction (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.]

La fonction SnmpOpen demande à l’implémentation de Microsoft WinSNMP d’ouvrir une session pour l’application WinSNMP. Cette fonction WinSNMP permet à l’implémentation d’allouer et d’initialiser la mémoire, les ressources, les structures de données et les mécanismes de communication. La fonction SnmpOpen retourne un handle à la nouvelle session WinSNMP.

Note Lors du développement de nouvelles applications WinSNMP, il est recommandé d’appeler la fonction SnmpCreateSession pour ouvrir une session WinSNMP au lieu d’appeler la fonction SnmpOpen .

Syntaxe

HSNMP_SESSION SNMPAPI_CALL SnmpOpen(
  [in] HWND hWnd,
  [in] UINT wMsg
);

Paramètres

[in] hWnd

Gérez vers une fenêtre de l’application WinSNMP pour notifier lorsqu’une demande asynchrone se termine ou quand une notification d’interruption se produit.

[in] wMsg

Spécifie un entier non signé qui identifie le message de notification à envoyer à la fenêtre de l’application WinSNMP.

Valeur retournée

Si la fonction réussit, la valeur de retour est un handle qui identifie la session WinSNMP que l’implémentation ouvre pour l’application appelante.

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_HWND_INVALID	Le paramètre hWnd n’est pas un handle de fenêtre valide.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

La fonction SnmpOpen retourne un handle unique à chaque session WinSNMP ouverte au sein de l’application WinSNMP appelante. L’application doit utiliser le handle de session que SnmpOpen retourne dans d’autres appels de fonction WinSNMP pour faciliter l’allocation et la répartition des ressources par l’implémentation. Lorsque l’implémentation alloue des ressources à une session individuelle, elle effectue une libération ordonnée des ressources en réponse à un appel à SnmpClose pour la session.

La fonction SnmpOpen transmet à l’implémentation le handle à une fenêtre d’application et un identificateur de message de notification. Si le composant wParam du message de notification spécifié par le paramètre wMsg est égal à zéro, l’application WinSNMP doit récupérer l’unité de données de protocole entrante (PDU). Pour ce faire, l’application appelle la fonction SnmpRecvMsg avec le handle de session retourné par SnmpOpen. Si le paramètre wParam du message de notification n’est pas égal à zéro, il représente un code d’erreur WinSNMP. Le code d’erreur s’applique à la PDU identifiée par l’identificateur de demande dans le paramètre lParam du message de notification.

Une application WinSNMP peut ouvrir plusieurs sessions WinSNMP. Si une application ouvre plusieurs sessions à l’aide du même handle de fenêtre, il est recommandé que l’application WinSNMP spécifie un paramètre wMsg unique pour chaque session.

Il est recommandé qu’une application WinSNMP appelle la fonction SnmpClose une fois pour chaque session que l’implémentation ouvre à la suite d’un appel à la fonction SnmpOpen . Si une application WinSNMP se termine de manière inattendue, elle doit appeler SnmpCleanup avant de se terminer pour permettre à l’implémentation de libérer toutes les ressources. L’implémentation traite un appel SnmpCleanup comme s’il s’agissait d’une série d’appels SnmpClose , un appel pour chaque session que l’implémentation ouvre à la suite d’un appel à SnmpOpen.

Pour plus d’informations sur l’ouverture d’une session WinSNMP et la spécification de la méthode utilisée pour informer la session des messages SNMP disponibles et des événements asynchrones, consultez SnmpCreateSession. Lorsque vous appelez SnmpCreateSession , vous pouvez spécifier un message de notification de fenêtre ou une fonction SNMPAPI_CALLBACK pour notifier la session.

Pour plus d’informations, consultez Sessions WinSNMP.

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