[PATCH 06/22] gweb: Add documentation to 'g_web_result_get_err'.
Grant Erickson <[email protected]>
| Newsgroups | dev.linux.lists.connman |
|---|---|
| Message-ID | <e78028fc1e4d24ed1f66aa927082bffdc09f8171.1741050622.git.gerickson@nuovations.com> |
Adds documentation to the 'g_web_result_get_err' function and the
associated 'struct _GWebResult' 'err' data member.
---
gweb/gweb.c | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/gweb/gweb.c b/gweb/gweb.c
index 6ada0dfa571c..72f83d8f27e4 100644
--- a/gweb/gweb.c
+++ b/gweb/gweb.c
@@ -55,6 +55,12 @@ enum chunk_state {
};
struct _GWebResult {
+ /**
+ * Operating system error, if any, associated with the request.
+ *
+ * 0 on success; otherwise, < 0 (negate to arrive at a POSIX
+ * domain error number).
+ */
int err;
guint16 status;
const guint8 *buffer;
@@ -2463,6 +2469,22 @@ bool g_web_cancel_request(GWeb *web, guint id)
return true;
}
+/**
+ * @brief
+ * Returns the operating system error, 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
+ * operating system error.
+ *
+ * @returns
+ * 0 on success; otherwise, < 0 (negate to arrive at a POSIX
+ * domain error number).
+ *
+ * @sa g_web_result_get_status
+ *
+ */
int g_web_result_get_err(const GWebResult *result)
{
if (!result)
--
2.45.0