Fonction SnmpStrToOid (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 SnmpStrToOid WinSNMP convertit le format de chaîne numérique en pointillés d’un identificateur d’objet SNMP, par exemple, « 1.2.3.4.5.6 », en sa représentation binaire interne.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpStrToOid(
  [in]  LPCSTR   string,
  [out] smiLPOID dstOID
);

Paramètres

[in] string

Pointeur vers une chaîne d’identificateur d’objet terminée par null à convertir.

[out] dstOID

Pointeur vers une structure smiOID qui reçoit la valeur convertie.

Valeur retournée

Si la fonction réussit, la valeur de retour est le nombre de sous-identificateurs dans l’identificateur d’objet converti. Ce nombre est également la valeur du membre len de la structure smiOID pointée vers le paramètre dstOID .

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_OID_INVALID
 Le paramètre string n’est pas valide. Pour plus d’informations, consultez la section Remarques suivante.
SNMPAPI_OTHER_ERROR
 Une erreur inconnue ou non définie s’est produite.

Remarques

L’application WinSNMP doit appeler la fonction SnmpFreeDescriptor pour libérer les ressources allouées au membre ptr de la structure smiOID pointée vers le paramètre dstOID . En entrée, SnmpFreeDescriptor ignore les membres de cette structure smiOID . L’implémentation de Microsoft WinSNMP remplace les membres smiOID si la fonction se termine correctement.

La fonction SnmpStrToOid échoue et retourne le code d’erreur SNMPAPI_OID_INVALID si le paramètre string remplit l’une des conditions suivantes :

  • N’est pas terminé par null.
  • N’est pas la forme textuelle d’un identificateur d’objet valide.
  • Est insuffisant en longueur; tous les identificateurs d’objet doivent avoir deux sous-identificateurs.
  • Dépasse le MAXOBJIDSTRSIZE de 1408 octets.
Pour plus d’informations, consultez Concepts winSNMP Gestion des données et Libération des descripteurs 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

SnmpFreeDescriptor

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP

smiOID