Fonctions WinSNMP

[SNMP peut être utilisé 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.]

Les fonctions utilisées avec l’WinSNMP sont classées dans les regroupements fonctionnels suivants. Une liste alphabétique suit.

Fonctions de communications WinSNMP

Les fonctions de communications WinSNMP fournissent une interface entre l’application WinSNMP d’appel et l’implémentation de l’WinSNMP Microsoft. L’implémentation gère la communication entre l’application et d’autres entités de gestion.

Fonction Description
SnmpCancelMsg Demande que l’implémentation de l’WinSNMP Microsoft annule les tentatives de retransmission et les notifications de délai d’attente pour un message de demande SNMP.
SnmpCleanup Informe l’implémentation qu’une application est déconnectée et ne nécessite plus de ressources allouées.
SnmpCleanupEx Effectue un nettoyage lorsqu’il n’existe aucun appel réussi à SnmpStartup ou SnmpStartupEx dans une application winsnmp.
SnmpClose Permet à l’implémentation de libérer les ressources associées à une session et de fermer les mécanismes de communication.
SnmpCreateSession Demande à l’implémentation d’ouvrir une session WinSNMP et d’allouer des ressources et des mécanismes de communication. Lorsque vous développez de nouvelles applications WinSNMP, il est recommandé d’appeler la fonction SnmpCreateSession pour ouvrir une session WinSNMP au lieu d’appeler la fonction SnmpOpen .
SnmpListen Inscrit ou annule l’inscription d’une application WinSNMP en tant qu’agent SNMP.
SnmpOpen Demande à l’implémentation d’ouvrir une session WinSNMP et d’allouer des ressources et des mécanismes de communication. Lorsque vous développez de nouvelles applications WinSNMP, il est recommandé d’appeler la fonction SnmpCreateSession pour ouvrir une session WinSNMP au lieu d’appeler la fonction SnmpOpen .
SnmpRecvMsg Retourne des messages SNMP, des données d’interruption et des notifications en attente.
SnmpRegister Informe l’implémentation que l’application doit inscrire ou annuler l’inscription pour les interruptions et les notifications.
SnmpSendMsg Demande que l’implémentation transmette une unité de données de protocole.
SnmpStartup Indique à l’implémentation d’effectuer des procédures d’initialisation pour l’application. Une application doit appeler la fonction SnmpStartup avec succès avant d’appeler une autre fonction winsnmp.
SnmpStartupEx Notifie l’implémentation de Microsoft WinSNMP que l’application WinSNMP requiert les services de l’implémentation. SnmpStartupEx permet la prise en charge de plusieurs modules logiciels indépendants qui utilisent WinSNMP au sein de la même application.
SNMPAPI_CALLBACK Avertit une session WinSNMP qu’un message SNMP ou un événement asynchrone est disponible.
[!Note]
Cette fonction de rappel s’applique uniquement aux sessions ouvertes à la suite d’un appel à la fonction SnmpCreateSession .

Fonctions d’entité et de contexte WinSNMP

L’entité WinSNMP et les fonctions de contexte permettent à une application WinSNMP de spécifier des noms conviviaux pour les entités et les contextes SNMP. L’implémentation de l’WinSNMP Microsoft traduit le nom en composants SNMPv1 ou SNMPv2C à l’aide de la base de données de l’implémentation.

Fonction Description
SnmpContextToStr Retourne une chaîne qui identifie un contexte SNMP (un ensemble de ressources d’objet managé).
SnmpEntityToStr Retourne une chaîne qui identifie une entité de gestion SNMP.
SnmpFreeContext Libère les ressources allouées par la fonction SnmpStrToContext pour un contexte SNMP.
SnmpFreeEntity Libère les ressources allouées par la fonction SnmpStrToEntity pour une entité de gestion SNMP.
SnmpSetPort Modifie le port affecté à une entité de destination SNMP.
SnmpStrToContext Retourne un handle vers des informations de contexte SNMP qui sont spécifiques à l’implémentation.
SnmpStrToEntity Retourne un handle pour les informations d’entité de gestion SNMP qui sont spécifiques à l’implémentation.

Fonctions de base de données WinSNMP

Les fonctions de base de données WinSNMP fournissent à une application WinSNMP un accès aux paramètres actuels dans le magasin d’informations d’administration de l’implémentation de Microsoft WinSNMP. Ces fonctions permettent de modifier le mode de retransmission et l’entité et le mode de traduction du contexte. Les fonctions de base de données fournissent également à l’application la possibilité de manipuler les valeurs de délai d’attente et de nombre de nouvelles tentatives.

Fonction Description
SnmpGetRetransmitMode Retourne le paramètre actuel du mode de retransmission.
SnmpGetRetry Retourne la valeur du nombre de tentatives, en unités, pour la retransmission des demandes de message SNMP.
SnmpGetTimeout Retourne la valeur du délai d’attente, en centièmes de seconde, pour la transmission des demandes de message SNMP.
SnmpGetTranslateMode Retourne le paramètre actuel de l’entité et du mode de traduction du contexte.
SnmpGetVendorInfo Récupère des informations qui identifient le fournisseur WinSNMP.
SnmpSetRetransmitMode Modifie le mode de retransmission.
SnmpSetRetry Modifie la valeur du nombre de tentatives pour la retransmission des demandes de message SNMP.
SnmpSetTimeout Modifie la valeur de délai d’attente pour la transmission des demandes de message SNMP.
SnmpSetTranslateMode Modifie l’entité et le mode de traduction du contexte.

Fonctions de l’IPDU WinSNMP

Les fonctions de l’IPDU WinSNMP permettent aux applications WinSNMP d’extraire et de mettre à jour les éléments de données (ou champs) d’une PDU. Cela comprend les PDU retournées par un appel à la fonction SnmpRecvMsg ou à la fonction SnmpDecodeMsg . Les fonctions PDU construisent également des PDU à utiliser dans les fonctions SnmpSendMsg et SnmpEncodeMsg .

Fonction Description
SnmpCreatePdu Crée et Initialise une unité de données de protocole SNMP.
SnmpDuplicatePdu Duplique une unité de données de protocole SNMP.
SnmpFreePdu Libère les ressources associées à une unité de données de protocole SNMP créée par SnmpCreatePdu ou la fonction SnmpDuplicatePdu .
SnmpGetPduData Retourne les éléments de données sélectionnés à partir d’une unité de données de protocole SNMP spécifiée.
SnmpSetPduData Met à jour les éléments de données sélectionnés dans une unité de données de protocole SNMP spécifiée.

Fonctions de l’utilitaire WinSNMP

Les fonctions de l’utilitaire WinSNMP permettent à une application WinSNMP de gérer des objets et des messages SNMP à travers l’interface WinSNMP.

Fonction Description
SnmpDecodeMsg Décode un message SNMP encodé ou sérialisé en ses composants constitutifs.
SnmpEncodeMsg Crée un message SNMP encodé.
SnmpFreeDescriptor Signale à l’implémentation de l’WinSNMP Microsoft qu’il doit libérer la mémoire allouée pour un descripteur spécifique.
SnmpGetLastError Retourne la dernière valeur de code d’erreur pour la dernière opération SNMP.
SnmpOidCompare Compare deux identificateurs d’objet SNMP.
SnmpOidCopy Copie un identificateur d’objet SNMP.
SnmpOidToStr Convertit la représentation binaire interne d’un identificateur d’objet SNMP en son format de chaîne numérique en pointillés.
SnmpStrToOid Convertit le format de chaîne numérique avec points d’un identificateur d’objet SNMP en sa représentation binaire interne.

Fonctions de liaison de variable WinSNMP

Les fonctions de liaison de la variable WinSNMP permettent aux applications WinSNMP de construire et de manipuler des listes de liaisons de variables, et de les inclure dans des PDU.

Fonction Description
SnmpCountVbl Énumère les entrées de liaison de variable dans une liste de liaisons de variables spécifiée.
SnmpCreateVbl Crée une nouvelle liste de liaisons de variables.
SnmpDeleteVb Supprime une entrée de liaison de variable d’une liste de liaisons de variables.
SnmpDuplicateVbl Copie une liste de liaisons de variables.
SnmpFreeVbl Libère des ressources pour une liste de liaisons de variable allouée précédemment par SnmpCreateVbl ou la fonction SnmpDuplicateVbl .
SnmpGetVb Récupère des informations à partir d’une entrée de liaison de variable spécifiée.
SnmpSetVb Modifie les entrées de liaison de variable dans une liste de liaisons de variables ; Ajoute de nouvelles entrées de liaison de variable à une liste de liaisons de variables existante.

Liste alphabétique des fonctions WinSNMP