[netfilter-cvslog] r6751 - trunk/libnetfilter_conntrack/src/conntrack

[pablo at netfilter.org]

Author: pablo at netfilter.org
Date: 2007-02-12 03:02:27 +0100 (Mon, 12 Feb 2007)
New Revision: 6751

Modified:
   trunk/libnetfilter_conntrack/src/conntrack/api.c
Log:
fix wrong documentation in nfct_attr_get_u[*] functions



Modified: trunk/libnetfilter_conntrack/src/conntrack/api.c
===================================================================
--- trunk/libnetfilter_conntrack/src/conntrack/api.c	2007-02-12 01:43:31 UTC (rev 6750)
+++ trunk/libnetfilter_conntrack/src/conntrack/api.c	2007-02-12 02:02:27 UTC (rev 6751)
@@ -278,8 +278,9 @@
  * @ct: pointer to a valid conntrack
  * @type: attribute type
  *
- * On error, -1 is returned and errno is set appropiately, otherwise
- * the value of the attribute is returned.
+ * Returns the value of the requested attribute, if the attribute is not 
+ * set, 0 is returned. In order to check if the attribute is set or not,
+ * use nfct_attr_is_set.
  */
 u_int8_t nfct_get_attr_u8(const struct nf_conntrack *ct,
 			  const enum nf_conntrack_attr type)
@@ -293,8 +294,9 @@
  * @ct: pointer to a valid conntrack
  * @type: attribute type
  *
- * On error, -1 is returned and errno is set appropiately, otherwise
- * the value of the attribute is returned.
+ * Returns the value of the requested attribute, if the attribute is not 
+ * set, 0 is returned. In order to check if the attribute is set or not,
+ * use nfct_attr_is_set.
  */
 u_int16_t nfct_get_attr_u16(const struct nf_conntrack *ct,
 			    const enum nf_conntrack_attr type)
@@ -308,8 +310,9 @@
  * @ct: pointer to a valid conntrack
  * @type: attribute type
  *
- * On error, -1 is returned and errno is set appropiately, otherwise
- * the value of the attribute is returned.
+ * Returns the value of the requested attribute, if the attribute is not 
+ * set, 0 is returned. In order to check if the attribute is set or not,
+ * use nfct_attr_is_set.
  */
 u_int32_t nfct_get_attr_u32(const struct nf_conntrack *ct,
 			    const enum nf_conntrack_attr type)