SnmpOidCompare, 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 SnmpOidCompare WinSNMP compare lexicographiquement deux identificateurs d’objet SNMP, jusqu’à la longueur spécifiée par le paramètre maxlen .

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpOidCompare(
  [in]  smiLPCOID xOID,
  [in]  smiLPCOID yOID,
  [in]  smiUINT32 maxlen,
  [out] smiLPINT  result
);

Paramètres

[in] xOID

Pointeur vers le premier identificateur d’objet smiOID à comparer. La longueur de l’identificateur d’objet peut être égale à zéro.

[in] yOID

Pointeur vers le deuxième identificateur d’objet smiOID à comparer. La longueur de l’identificateur d’objet peut être égale à zéro.

[in] maxlen

S’il n’est pas égal à zéro, spécifie le nombre de sous-identificateurs à comparer. Ce paramètre doit être inférieur à MAXOBJIDSIZE : 128 sous-identificateurs, le nombre maximal de composants dans un identificateur d’objet. Pour plus d’informations, consultez la section Remarques suivante.

[out] result

Pointeur vers une variable entière pour recevoir le résultat de la comparaison. La variable peut recevoir l’un des résultats suivants.

Résultats Signification
Supérieur à 0
 xOID est supérieur à yOID
Égal à 0
 xOID est égal à yOID
Inférieure à 0
 xOID est inférieur à yOID
 

Pour obtenir des conditions de comparaison supplémentaires, consultez la section Remarques suivante.

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 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
 L’un ou les deux paramètres xOID et yOID n’est pas valide.
SNMPAPI_SIZE_INVALID
 Le paramètre maxlen n’est pas valide. La taille du paramètre est supérieure à MAXOBJIDSIZE.
SNMPAPI_OTHER_ERROR
 Une erreur inconnue ou non définie s’est produite.

Remarques

Une application WinSNMP peut appeler la fonction SnmpOidCompare pour déterminer si deux identificateurs d’objet ont des préfixes communs.

Si le paramètre maxlen n’est pas égal à zéro et n’est pas supérieur à MAXOBJIDSIZE, la valeur de maxlen définit la limite supérieure du nombre de sous-identificateurs à comparer. Nombre maximal de sous-identificateurs que la fonction SnmpOidCompare compare par défaut à celui qui correspond au plus petit nombre( le paramètre maxlen ou le membre len de l’une des structures smiOID pointées par les paramètres xOID et yOID .

Si le paramètre maxlen est égal à zéro, le nombre maximal de sous-identificateurs que la fonction SnmpOidCompare compare par défaut au nombre qui est le plus petit des membres len des deux structures smiOID .

La valeur du paramètre de résultat indique que xOID est égal à yOID si les deux structures smiOID sont égales au niveau lexicographique et si l’une des opérations suivantes se produit :

  • SnmpOidCompare compare un nombre maximal de sous-identificateurs.
  • SnmpOidCompare compare le nombre maximal de sous-identificateurs, et les membres len des deux structures smiOID sont égaux, mais inférieurs au paramètre maxlen .

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

Fonctions WinSNMP

Vue d’ensemble de l’API WinSNMP

smiOID