Fonction SnmpContextToStr (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. Au lieu de cela, utilisez La gestion à distance Windows, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpContextToStr WinSNMP retourne une chaîne qui identifie un contexte SNMP, qui est un ensemble de ressources d’objet managées. La fonction retourne la chaîne dans une structure smiOCTETS .

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpContextToStr(
  [in]  HSNMP_CONTEXT context,
  [out] smiLPOCTETS   string
);

Paramètres

[in] context

Gérez le contexte SNMP qui vous intéresse.

[out] string

Pointeur vers une structure smiOCTETS pour recevoir la chaîne qui identifie le contexte d’intérêt. La chaîne peut avoir un octet de fin null.

Valeur retournée

Si la fonction réussit, la valeur de retour est SNMPAPI_SUCCESS.

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_CONTEXT_INVALID	Le paramètre de contexte n’est pas valide.
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

Le paramètre actuel du mode de traduction d’entité et de contexte détermine le type de chaîne de sortie SnmpContextToStr retourné. Pour plus d’informations, consultez Définition du mode de traduction d’entité et de contexte.

L’application WinSNMP doit fournir l’adresse d’une structure smiOCTETS valide pour le paramètre string . Si la fonction SnmpContextToStr se termine correctement, l’implémentation Microsoft WinSNMP initialise les membres len et ptr de la structure. L’application WinSNMP doit appeler la fonction SnmpFreeDescriptor pour permettre à l’implémentation de libérer les ressources pour ces membres.

Lorsque le mode de traduction d’entité et de contexte est SNMPAPI_TRANSLATED et que l’entrée existe dans la base de données de l’implémentation, l’implémentation retourne le nom convivial associé du contexte. S’il n’existe pas d’entrée pour le nom du contexte, SnmpContextToStr retourne la chaîne de la communauté SNMP.

Lorsque le mode de traduction d’entité et de contexte est SNMPAPI_UNTRANSLATED_V1 ou SNMPAPI_UNTRANSLATED_V2, l’implémentation retourne également la chaîne de la communauté SNMP.

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

Voir aussi

SnmpFreeDescriptor

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP

smiOCTETS