aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2020-09-17 14:55:39 +0200
committerEduardo Habkost <ehabkost@redhat.com>2020-09-18 13:49:48 -0400
commitd20f616e8f8f8f8fdb04da850d9ce92880199db7 (patch)
tree8be4116314f1fb807573c36b1c8eec2eb9d58b62 /include
parent04dcf4b5db98db8023f895e1f557baf45b34735d (diff)
downloadqemu-d20f616e8f8f8f8fdb04da850d9ce92880199db7.zip
qemu-d20f616e8f8f8f8fdb04da850d9ce92880199db7.tar.gz
qemu-d20f616e8f8f8f8fdb04da850d9ce92880199db7.tar.bz2
qom: Clean up object_property_get_enum()'s error value
object_property_get_enum() is the only object_property_FOO() that is documented to return an undefined value on error. It does no such thing, actually: it returns 0 on some errors, and -1 on others. Needlessly complicated. Always return -1 on error, and adjust the contract. Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Greg Kurz <groug@kaod.org> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Message-Id: <20200917125540.597786-2-armbru@redhat.com> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Diffstat (limited to 'include')
-rw-r--r--include/qom/object.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/qom/object.h b/include/qom/object.h
index 6c0d424..494827b 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1687,9 +1687,9 @@ uint64_t object_property_get_uint(Object *obj, const char *name,
* @typename: the name of the enum data type
* @errp: returns an error if this function fails
*
- * Returns: the value of the property, converted to an integer, or
- * undefined if an error occurs (including when the property value is not
- * an enum).
+ * Returns: the value of the property, converted to an integer (which
+ * can't be negative), or -1 on error (including when the property
+ * value is not an enum).
*/
int object_property_get_enum(Object *obj, const char *name,
const char *typename, Error **errp);