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

La fonction SnmpOidToStr WinSNMP convertit la représentation binaire interne d’un identificateur d’objet SNMP en son format de chaîne numérique en pointillés, par exemple en « 1.2.3.4.5.6 ».

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpOidToStr(
  [in]  smiLPCOID srcOID,
  [in]  smiUINT32 size,
  [out] LPSTR     string
);

Paramètres

[in] srcOID

Pointeur vers une structure smiOID avec un identificateur d’objet à convertir.

[in] size

Spécifie la taille, en octets, de la mémoire tampon indiquée par le paramètre string . Pour plus d'informations, consultez la section Notes qui suit.

[out] string

Pointeur vers une mémoire tampon pour recevoir l’identificateur d’objet string converti qui spécifie l’entité de gestion SNMP.

Valeur retournée

Si la fonction réussit, la valeur de retour est la longueur, en octets, de la chaîne que l’application WinSNMP écrit dans le paramètre string . La valeur de retour inclut un octet de fin null. Cette valeur peut être inférieure ou égale à la valeur du paramètre size , mais elle n’est peut-être pas supérieure.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError en spécifiant une valeur NULL dans son paramètre de session . 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_SIZE_INVALID
 Le paramètre size n’est pas valide. Ce paramètre ne peut pas être égal à zéro ; il doit indiquer la taille de la mémoire tampon pointée vers le paramètre string .
SNMPAPI_OID_INVALID
 Le paramètre srcOID n’est pas valide. Pour plus d’informations, consultez la section Remarques suivante.
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

Il est recommandé qu’une application WinSNMP spécifie, avec le paramètre size , une mémoire tampon de chaîne de longueur MAXOBJIDSTRSIZE (1408 octets). Cela garantit que la mémoire tampon de sortie est suffisamment grande pour contenir la chaîne convertie. Étant donné que la chaîne convertie est généralement inférieure à MAXOBJIDSTRSIZE, l’application WinSNMP peut copier la chaîne convertie dans une mémoire tampon plus petite. L’application peut ensuite réutiliser ou libérer la mémoire allouée pour la mémoire tampon initiale. Pour plus d’informations, consultez Concepts de Gestion des données WinSNMP.

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

SnmpStrToOid

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP

smiOID