Value
Mise à jour : novembre 2007
La propriété TheValue est utilisée pour indiquer une valeur de retour de fonction non valide que l'appelant peut tester par erreur pour voir si une fonction a réussi ou a échoué. Cette propriété est autorisée sur l'attribut InvalidCheck.
L'attribut InvalidCheck et la propriété Value fournissent un mécanisme qui permet d'effectuer un test avec la valeur de retour correcte d'une fonction. Il essaie de traiter le problème qui se produit généralement lorsqu'une fonction retourne 1 en cas de succès et 0 en cas d'échec, tandis qu'une autre fonction retourne 1 en cas de succès et -1 en cas d'échec. L'utilisation de valeurs légèrement différentes pour indiquer différents résultats provoque la confusion et par conséquent introduit des erreurs dans le code. En annotant des fonctions à l'aide de la propriété Value, vous pouvez aider les appelants à vérifier la valeur de retour correcte.
Exemple
Le code suivant illustre l'utilisation de la propriété Value :
#include <CodeAnalysis\SourceAnnotations.h>
[returnvalue:SA_InvalidCheck(Value=0)] int f( ); // 1 and -1 are valid
Value=0 indique que le contrôle de la valeur de retour 0 est une erreur parce que cette fonction ne peut retourner que 1 ou -1 et que 0 est une valeur non valide.
Sur le site d'appel, un avertissement est émis si l'appelant vérifie la valeur de retour à l'aide du code suivant parce que 0 n'est pas une valeur de retour valide :
if ( f() == 0 )
Voir aussi
Concepts
Vue d'ensemble de l'annotation