SnmpEntityToStr, fonction (winsnmp.h)

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

La fonction SnmpEntityToStr WinSNMP retourne une chaîne qui identifie une entité de gestion SNMP.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
  [in]  HSNMP_ENTITY entity,
  [in]  smiUINT32    size,
  [out] LPSTR        string
);

Paramètres

[in] entity

Gérez l’entité de gestion SNMP qui vous intéresse.

[in] size

Spécifie la taille, en octets, de la mémoire tampon pointée vers le paramètre de chaîne . L’application WinSNMP doit allouer une mémoire tampon suffisamment grande pour contenir la chaîne de sortie.

[out] string

Pointeur vers une mémoire tampon pour recevoir la chaîne terminée par null qui identifie l’entité de gestion SNMP intéressante.

Valeur retournée

Si la fonction réussit, la valeur de retour correspond au nombre d’octets, y compris un octet null de fin, que SnmpEntityToStr retourne dans la mémoire tampon de chaîne . Cette valeur peut être inférieure ou égale à la valeur du paramètre size , mais elle ne peut pas être supérieure.

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_ENTITY_INVALID
 Le paramètre d’entité n’est pas valide.
SNMPAPI_OUTPUT_TRUNCATED
 La longueur de la mémoire tampon de sortie est insuffisante.
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 le type de chaîne de sortie retournée par SnmpEntityToStr . 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.

Quand l’entité et le mode de traduction de contexte sont SNMPAPI_TRANSLATED et qu’une entrée existe dans la base de données de l’implémentation, l’implémentation retourne le nom convivial associé de l’entité de gestion. S’il n’existe pas d’entrée pour l’entité de gestion, SnmpEntityToStr retourne l’adresse de transport SNMP littérale de l’entité de gestion.

Lorsque le mode de traduction de l’entité et du contexte est SNMPAPI_UNTRANSLATED_V1 ou SNMPAPI_UNTRANSLATED_V2, l’implémentation de Microsoft WinSNMP retourne également l’adresse de transport SNMP littérale de l’entité de gestion.

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

Voir aussi

SnmpStrToEntity

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP