contract label length to conf params

[frescor/frsh-include.git] / frsh_core.h

diff --git a/frsh_core.h b/frsh_core.h
index 4c35df8d9ae19e678df1d1397079cc6535c0bce6..d9b285af47a3b5e8a38cacadae9ef079fb3835f1 100644 (file)
--- a/frsh_core.h
+++ b/frsh_core.h
@@ -255,10 +255,13 @@ int frsh_contract_get_basic_params
 /**
  * frsh_contract_set_resource_and_label()
  *
- * Specify processor_id/network_id and whether it is a processor or a
- * network.  Otherwise default values (type is processor and id is #0
- * will apply.
+ * Specify resource_id and type, and the contract label. Otherwise
+ * default values will apply. If the contract label is too long it is truncated
+ *
+ * @return   0 if no error \n
+ *       FRSH_ERR_BAD_ARGUMENT :  if the contract pointer is NULL.
  **/
+
 int frsh_contract_set_resource_and_label
   (frsh_contract_t *contract,
    const frsh_resource_type_t resource_type,
@@ -269,9 +272,11 @@ int frsh_contract_set_resource_and_label
 /**
  * frsh_contract_get_resource_and_label()
  *
- * Specify processor_id/network_id and whether it is a processor or a
- * network.  Otherwise default values (processor and processor #0 will
- * apply.
+ * Obtain the resource_id and type, and the contract label.
+ *
+ * @return   0 if no error \n
+ *       FRSH_ERR_BAD_ARGUMENT :  if the contract or the contract_label
+                                  pointer is NULL.
  **/
 int frsh_contract_get_resource_and_label
   (const frsh_contract_t *contract,