From 5a08b434c7ddecb9cab0f8aedd9db679ca35395c Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Tue, 18 Mar 2008 00:48:23 +0000
Subject: [Settings] show_setting() functions return snprintf()-style length.

show_setting() and related functions now return an "actual length" in the
style of snprintf().  This is to allow consumers to allocate buffers large
enough to hold the formatted setting.
---
 src/core/settings.c | 17 +++++++----------
 1 file changed, 7 insertions(+), 10 deletions(-)

(limited to 'src/core')

diff --git a/src/core/settings.c b/src/core/settings.c
index 42029fdcd..258fc1c7a 100644
--- a/src/core/settings.c
+++ b/src/core/settings.c
@@ -123,7 +123,7 @@ find_or_build_config_setting ( const char *name,
  * @v name		Configuration setting name
  * @v buf		Buffer to contain value
  * @v len		Length of buffer
- * @ret rc		Return status code
+ * @ret len		Length of formatted value, or negative error
  */
 int show_named_setting ( struct config_context *context, const char *name,
 			 char *buf, size_t len ) {
@@ -180,7 +180,7 @@ int set_setting ( struct config_context *context,
  * @v setting		Configuration setting
  * @v buf		Buffer to contain value
  * @v len		Length of buffer
- * @ret rc		Return status code
+ * @ret len		Length of formatted value, or negative error
  */
 static int show_string ( struct config_context *context,
 			 struct config_setting *setting,
@@ -190,8 +190,7 @@ static int show_string ( struct config_context *context,
 	option = find_dhcp_option ( context->options, setting->tag );
 	if ( ! option )
 		return -ENODATA;
-	dhcp_snprintf ( buf, len, option );
-	return 0;
+	return dhcp_snprintf ( buf, len, option );
 }
 
 /**
@@ -229,7 +228,7 @@ struct config_setting_type config_setting_type_string __config_setting_type = {
  * @v setting		Configuration setting
  * @v buf		Buffer to contain value
  * @v len		Length of buffer
- * @ret rc		Return status code
+ * @ret len		Length of formatted value, or negative error
  */
 static int show_ipv4 ( struct config_context *context,
 		       struct config_setting *setting,
@@ -241,8 +240,7 @@ static int show_ipv4 ( struct config_context *context,
 	if ( ! option )
 		return -ENODATA;
 	dhcp_ipv4_option ( option, &ipv4 );
-	snprintf ( buf, len, inet_ntoa ( ipv4 ) );
-	return 0;
+	return snprintf ( buf, len, inet_ntoa ( ipv4 ) );
 }
 
 /**
@@ -283,7 +281,7 @@ struct config_setting_type config_setting_type_ipv4 __config_setting_type = {
  * @v setting		Configuration setting
  * @v buf		Buffer to contain value
  * @v len		Length of buffer
- * @ret rc		Return status code
+ * @ret len		Length of formatted value, or negative error
  */
 static int show_int ( struct config_context *context,
 		      struct config_setting *setting,
@@ -295,8 +293,7 @@ static int show_int ( struct config_context *context,
 	if ( ! option )
 		return -ENODATA;
 	num = dhcp_num_option ( option );
-	snprintf ( buf, len, "%ld", num );
-	return 0;
+	return snprintf ( buf, len, "%ld", num );
 }
 
 /**
-- 
cgit v1.2.3-55-g7522