Value
Aktualisiert: November 2007
Mit der Value-Eigenschaft wird ein ungültiger Rückgabewert einer Funktion angegeben, den der Aufrufer möglicherweise versehentlich auf erfolgreiche oder fehlgeschlagene Ausführung der Funktion testet. Diese Eigenschaft ist beim InvalidCheck-Attribut zulässig.
Das InvalidCheck-Attribut und die Value-Eigenschaft stellen einen Mechanismus zum Testen des Rückgabewerts einer Funktion auf seine Richtigkeit bereit. Damit wird dem Problem Rechnung getragen, das i. d. R. auftritt, wenn eine Funktion 1 für Erfolg und 0 für Fehler zurückgibt, eine andere Funktion jedoch 1 für Erfolg und -1 für Fehler. Die Verwendung unterschiedlicher Werte für die gleichen Ergebnisse stiftet Verwirrung und verursacht Fehler im Code. Indem Sie mithilfe der Value-Eigenschaft Anmerkungen zu Funktionen hinzufügen, können Sie Aufrufer beim Überprüfen des Rückgabewerts auf seine Richtigkeit unterstützen.
Beispiel
Der folgende Code zeigt, wie die Value-Eigenschaft verwendet wird:
#include <CodeAnalysis\SourceAnnotations.h>
[returnvalue:SA_InvalidCheck(Value=0)] int f( ); // 1 and -1 are valid
Value=0 gibt an, dass die Überprüfung auf den Rückgabewert 0 (null) einen Fehler ergibt, da diese Funktion nur 1 und -1 zurückgeben kann und 0 (null) ein ungültiger Wert ist.
Auf der Aufrufsite wird eine Warnung ausgegeben, wenn der Aufrufer den Rückgabewert mithilfe des folgenden Codes überprüft, da 0 (null) kein gültiger Rückgabewert ist:
if ( f() == 0 )