Fonctions WinSNMP

  • Article

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

Les fonctions utilisées avec WinSNMP appartiennent aux regroupements fonctionnels suivants. Une liste alphabétique suit.

Fonctions de communication WinSNMP

Les fonctions de communication WinSNMP fournissent une interface entre l’application WinSNMP appelante et l’implémentation de Microsoft WinSNMP. 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 Microsoft WinSNMP 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 se déconnecte et ne nécessite plus de ressources allouées.
SnmpCleanupEx Effectue le nettoyage lorsqu’il n’y a pas d’appels réussis en cours à SnmpStartup ou SnmpStartupEx dans une application WinSNMP.
SnmpClose Permet à l’implémentation de désallouer 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. 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 .
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. 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 .
SnmpRecvMsg Retourne les messages SNMP et les données et notifications d’interruption en suspens.
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 Avertit l’implémentation d’effectuer des procédures d’initialisation pour l’application. Une application doit appeler correctement la fonction SnmpStartup avant d’appeler une autre fonction WinSNMP.
SnmpStartupEx Avertit l’implémentation de Microsoft WinSNMP que l’application WinSNMP nécessite les services de l’implémentation. SnmpStartupEx permet la prise en charge de plusieurs modules logiciels indépendants qui utilisent WinSNMP dans 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 contextes SNMP. L’implémentation de Microsoft WinSNMP traduit le nom en ses 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 (ensemble de ressources d’objets managés).
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 aux informations de contexte SNMP spécifiques à l’implémentation.
SnmpStrToEntity Retourne un handle aux informations d’entité de gestion SNMP 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 administratives de l’implémentation Microsoft WinSNMP. Ces fonctions permettent de modifier le mode de retransmission et le mode de traduction d’entité et de contexte. Les fonctions de base de données permettent également à l’application 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 nouvelles tentatives, en unités, pour la retransmission des demandes de message SNMP.
SnmpGetTimeout Retourne la valeur de délai d’attente, en centièmes de seconde, pour la transmission des demandes de messages SNMP.
SnmpGetTranslateMode Retourne le paramètre actuel du mode de traduction d’entité et de contexte.
SnmpGetVendorInfo Récupère les informations qui identifient le fournisseur WinSNMP.
SnmpSetRetransmitMode Change le mode de retransmission.
SnmpSetRetry Modifie la valeur du nombre de nouvelles tentatives pour la retransmission des demandes de messages SNMP.
SnmpSetTimeout Modifie la valeur de délai d’attente pour la transmission des demandes de messages SNMP.
SnmpSetTranslateMode Modifie le mode de traduction d’entité et de contexte.

Fonctions PDU WinSNMP

Les fonctions PDU WinSNMP permettent aux applications WinSNMP d’extraire et de mettre à jour les éléments de données (ou les champs) d’une PDU. Cela inclut les PDE retournées par un appel à la fonction SnmpRecvMsg ou à la fonction SnmpDecodeMsg . Les fonctions PDU construisent également des PDU pour une utilisation 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 la fonction SnmpCreatePdu ou 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 Mises à jour éléments de données sélectionnés dans une unité de données de protocole SNMP spécifiée.

Fonctions utilitaires WinSNMP

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

Fonction Description
SnmpDecodeMsg Décode un message SNMP encodé ou sérialisé dans ses composants constitutifs.
SnmpEncodeMsg Crée un message SNMP encodé.
SnmpFreeDescriptor Signale à l’implémentation Microsoft WinSNMP qu’elle doit libérer la mémoire allouée pour un descripteur spécifique.
SnmpGetLastError Retourne la valeur de code de dernière 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 en pointillés d’un identificateur d’objet SNMP en sa représentation binaire interne.

Fonctions de liaison de variable WinSNMP

Les fonctions de liaison de variables 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 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 variables allouée précédemment par la fonction SnmpCreateVbl ou 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