[PATCH v3 07/18] gweb: Add documentation to 'g_web_result_get_status'.
Grant Erickson <[email protected]> Thu, 20 Mar 2025 16:38:58 -0700
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <e8edeeaa7d76932cb4051b408efeafaa77b1670f.1742513884.git.gerickson@nuovations.com> |
Add documentation to the 'g_web_result_get_status' function.
---
gweb/gweb.c | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index e4dad4f95e42..c22ca8ef0aff 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -2493,6 +2493,19 @@ bool g_web_cancel_request(GWeb *web, guint id)
return true;
}
+/**
+ * @brief
+ * Returns the HTTP status code, if any, associated with the
+ * web session request result.
+ *
+ * @param[in] result A pointer to the immutable web session
+ * request result for which to return the
+ * HTTP status code.
+ *
+ * @returns
+ * The HTTP status code.
+ *
+ */
guint16 g_web_result_get_status(GWebResult *result)
{
if (!result)
--
2.45.0