path: root/brandt.h
diff options
authorMarkus Teich <>2016-11-22 00:29:27 +0100
committerMarkus Teich <>2016-11-22 00:29:27 +0100
commite9d1c7ba005dda68148651119234b0ab076302d1 (patch)
tree9b709be51ec7d80a85735ba6e1ac0a516378192e /brandt.h
parent1e83436746c87ae2671a5541a5e020ae61b49555 (diff)
BRANDT_new() returns NULL on parameter failure
Diffstat (limited to 'brandt.h')
1 files changed, 2 insertions, 1 deletions
diff --git a/brandt.h b/brandt.h
index 101debf..6d68f0a 100644
--- a/brandt.h
+++ b/brandt.h
@@ -211,7 +211,8 @@ BRANDT_join (BRANDT_CbResult result,
* @param[in] outcome_public If 1, the auction winner and price will be public
* to all participants, if 0, this information will only be revealed to the
* winner and the seller.
- * @return A pointer, which should only be remembered and passed to
+ * @return If invalid parameters are passed, NULL is returned. Else the return
+ * value is a pointer, which should only be remembered and passed to
* libbrandt functions when the client needs to refer to this auction. This is a
* black-box pointer, do NOT dereference/change it or the data it points to!