SnmpStrToEntity, fonction (winsnmp.h)

Article
03/06/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. Utilisez plutôt Windows Remote Management, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpStrToEntity WinSNMP retourne un handle aux informations sur une entité de gestion SNMP spécifique à l’implémentation de Microsoft WinSNMP.

Syntaxe

HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
  [in] HSNMP_SESSION session,
  [in] LPCSTR        string
);

Paramètres

[in] session

Gérez la session WinSNMP.

[in] string

Pointeur vers une chaîne terminée par null qui identifie l’entité de gestion SNMP intéressante. Le paramètre actuel du mode de traduction de l’entité et du contexte détermine la façon dont SnmpStrToEntity interprète la chaîne d’entrée comme suit.

Mode de traduction entité/contexte	Signification
SNMPAPI_TRANSLATED	L’implémentation interprète le paramètre de chaîne comme un nom convivial. L’implémentation traduit le nom en ses composants SNMPv1 ou SNMPv2C à l’aide de la base de données de l’implémentation.
SNMPAPI_UNTRANSLATED_V1	L’implémentation interprète le paramètre de chaîne comme une adresse de transport SNMP littérale.
SNMPAPI_UNTRANSLATED_V2	L’implémentation interprète le paramètre de chaîne comme une adresse de transport SNMP littérale.

Valeur retournée

Si la fonction réussit, la valeur de retour est un handle pour l’entité de gestion SNMP qui vous intéresse.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError. 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_SESSION_INVALID	Le paramètre de session n’est pas valide.
SNMPAPI_ENTITY_UNKNOWN	La chaîne d’entité n’est pas valide.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

Le paramètre actuel de l’entité et du mode de traduction de contexte détermine la façon dont SnmpStrToEntity interprète la chaîne d’entrée qui identifie l’entité de gestion qui vous intéresse. Pour plus d’informations, consultez Prise en charge des chaînes d’adresse IPX dans WinSNMP et Définition du mode de traduction d’entité et de contexte.

L’application WinSNMP doit appeler la fonction SnmpFreeEntity pour libérer le handle d’entité alloué par la fonction SnmpStrToEntity . Pour plus d’informations, consultez Concepts de Gestion des données WinSNMP.

La fonction SnmpStrToEntity retourne un handle d’entité valide qu’une application WinSNMP peut utiliser comme paramètre srcEntity ou dstEntity dans plusieurs fonctions WinSNMP. Ces fonctions incluent les fonctions SnmpSendMsg, SnmpRecvMsg, SnmpRegister, SnmpEncodeMsg et SnmpDecodeMsg .

L’implémentation retourne l’entité actuelle et le mode de traduction de contexte dans le paramètre nTranslateMode de la fonction SnmpStartup . Une application WinSNMP peut modifier le paramètre de l’entité et du mode de traduction de contexte avec un appel à la fonction SnmpSetTranslateMode .

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