Value

Actualización: noviembre 2007

La propiedad Value se utiliza para indicar que valor devuelto por una función no es válido un aunque el llamador (por error) podría comprobarlo para ver si una función se ha ejecutado correctamente o ha provocado un error. Esta propiedad se permite en el atributo InvalidCheck.

El atributo InvalidCheck y la propiedad Value proporcionan un mecanismo para ayudar a comprobar si el valor devuelto de una función es correcto. Intenta abordar el problema que suele presentarse cuando una función devuelve 1 cuando se ejecuta correctamente y 0 cuando provoca un error y otra función devuelve 1 cuando se ejecuta correctamente y -1 en caso de error. El uso de valores ligeramente diferentes para indicar distintos resultados provoca confusión y, por consiguiente, introduce errores en el código. Al anotar las funciones mediante propiedad Value, puede contribuir a que los llamadores comprueben cuál es el valor devuelto correcto.

Ejemplo

En el siguiente código se muestra cómo se utiliza la propiedad Value:

#include <CodeAnalysis\SourceAnnotations.h>

[returnvalue:SA_InvalidCheck(Value=0)] int f( ); // 1 and -1 are valid

Value=0 indica que la comprobación del valor devuelto 0 es un error porque esta función sólo puede devolver 1 ó -1 y, por lo tanto, el valor 0 no es válido.

En el sitio de llamada, se emite una advertencia cuando el llamador comprueba el valor devuelto utilizando el código siguiente, porque 0 no es un valor devuelto válido:

if ( f() == 0 )

Vea también

Conceptos

Información general sobre anotaciones

Otros recursos

Propiedades de anotación