Fonction SnmpMgrOpen (mgmtapi.h)

Article
02/29/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 SnmpMgrOpen initialise les sockets de communication et les structures de données, ce qui autorise les communications avec l’agent SNMP spécifié. Cette fonction est un élément de l’API gestion SNMP.

Syntaxe

LPSNMP_MGR_SESSION SNMP_FUNC_TYPE SnmpMgrOpen(
  [in] LPSTR lpAgentAddress,
  [in] LPSTR lpAgentCommunity,
  [in] INT   nTimeOut,
  [in] INT   nRetries
);

Paramètres

[in] lpAgentAddress

Pointeur vers une chaîne terminée par null qui spécifie un nom d’hôte ou une adresse IP. Le nom d’hôte doit être résolu en une adresse IP, une adresse IPX (en notation 8.12) ou une adresse Ethernet. Consultez la section Remarques pour connaître les formulaires acceptables pour les noms d’hôtes et les adresses IP.

[in] lpAgentCommunity

Pointeur vers une chaîne terminée par null qui spécifie le nom de la communauté SNMP à utiliser lors de la communication avec l’agent identifié par le paramètre lpAgentAddress .

[in] nTimeOut

Spécifie le délai d’attente des communications en millisecondes.

[in] nRetries

Spécifie le nombre de nouvelles tentatives de communication. Le délai d’attente spécifié dans le paramètre nTimeOut est doublé chaque fois qu’une nouvelle tentative est transmise.

Valeur retournée

Si la fonction réussit, la valeur de retour est un pointeur vers une structure LPSNMP_MGR_SESSION . Cette structure est utilisée en interne et le programmeur ne doit pas la modifier. Pour plus d'informations, consultez la section Notes qui suit.

Si la fonction échoue, la valeur de retour est NULL. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. GetLastError peut retourner le code d’erreur SNMP_MEM_ALLOC_ERROR, ce qui indique une erreur d’allocation de mémoire.

Cette fonction peut également retourner les codes d’erreur des sockets Windows.

Remarques

Si possible, utilisez un nom d’hôte pour identifier l’agent SNMP dans le paramètre lpAgentAddress . Les noms d’hôte ne peuvent être fournis pour les agents que si TCP/IP est chargé et que les noms sont des noms d’hôtes TCP/IP. Les noms NetBIOS ne peuvent pas être fournis pour les hôtes IPX.

Le nom et l’adresse de la cible SNMP, ou la chaîne pointée par le paramètre lpAgentAddress , doivent être conformes à l’un des formulaires suivants.

Nom/adresse	Formulaire (exemple)
Nom d’hôte	merlin ou merlin.microsoft.com
Adresse IPv4	157.57.8.160
Adresse IPv6	3ffe :8311 :ffff ::b3ff :fe88 :c33
Adresse MAC	00aa00bbccdd
Adresse IPX	00006112.00aa00bbccddd

Les applications ne doivent pas utiliser le pointeur LPSNMP_MGR_SESSION retourné par cette fonction pour appeler la fonction SnmpMgrRequest dans le contexte d’un autre thread.

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	mgmtapi.h
Bibliothèque	Mgmtapi.lib
DLL	Mgmtapi.dll

Voir aussi

Fonctions SNMP

Vue d’ensemble du protocole SNMP (Simple Network Management Protocol)

SnmpMgrClose

SnmpMgrRequest

Partager via