SnmpStrToContext, fonction (winsnmp.h)

Article
08/27/2023

[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 SnmpStrToContext WinSNMP retourne un handle aux informations de contexte SNMP spécifiques à l’implémentation De Microsoft WinSNMP. Le handle est une valeur valide qu’une application WinSNMP peut utiliser comme paramètre de contexte dans un appel aux fonctions SnmpSendMsg et SnmpRegister .

Syntaxe

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

Paramètres

[in] session

Gérez la session WinSNMP.

[in] string

Pointeur vers une structure smiOCTETS qui contient une chaîne à interpréter. La chaîne peut identifier une collection d’objets managés, ou il peut s’agir d’une chaîne de communauté.

Le paramètre actuel du mode de traduction de l’entité et du contexte détermine la façon dont SnmpStrToContext interprète la structure de chaîne d’entrée, comme indiqué dans le tableau suivant.

Mode de traduction entité/contexte	Signification
SNMPAPI_TRANSLATED	L’implémentation interprète le paramètre de chaîne comme un nom convivial pour une collection d’objets managés. 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 string comme une chaîne de communauté SNMP littérale.
SNMPAPI_UNTRANSLATED_V2	L’implémentation interprète le paramètre string comme une chaîne de communauté SNMP littérale.

Valeur retournée

Si la fonction réussit, la valeur de retour est un handle pour le contexte d’intérêt.

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_CONTEXT_INVALID	Le format du paramètre de chaîne n’est pas valide. Par exemple, le membre len ou le membre ptr de la structure smiOCTETS vers laquelle pointe le paramètre de chaîne est NULL.
SNMPAPI_CONTEXT_UNKNOWN	La valeur référencée dans le paramètre de chaîne n’existe pas.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

Le paramètre actuel du mode de traduction de l’entité et du contexte détermine la façon dont SnmpStrToContext interprète la structure de chaîne d’entrée. Pour plus d’informations, consultez Définition du mode de traduction d’entité et de contexte.

L’application WinSNMP doit appeler la fonction SnmpFreeContext pour libérer le handle de contexte alloué par la fonction SnmpStrToContext . Pour plus d’informations sur la publication de ressources, consultez Concepts de Gestion des données WinSNMP.

L’application WinSNMP doit libérer la mémoire associée au membre ptr de la structure smiOCTETS vers laquelle pointe le paramètre string . En effet, l’application définit et alloue les ressources. Par exemple, si l’application a alloué des ressources avec un appel à la fonction GlobalAlloc , elle doit utiliser la fonction GlobalFree pour libérer les ressources. Pour plus d’informations, consultez Freeing WinSNMP Descriptors.

Configuration requise


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