aboutsummaryrefslogtreecommitdiffstats
path: root/capchild/capture_sync.h
diff options
context:
space:
mode:
Diffstat (limited to 'capchild/capture_sync.h')
-rw-r--r--capchild/capture_sync.h19
1 files changed, 18 insertions, 1 deletions
diff --git a/capchild/capture_sync.h b/capchild/capture_sync.h
index 17dc35d347..e8ba98b3ad 100644
--- a/capchild/capture_sync.h
+++ b/capchild/capture_sync.h
@@ -63,7 +63,24 @@ sync_pipe_stop(capture_session *cap_session);
extern void
sync_pipe_kill(ws_process_id fork_child);
-/** Set wireless channel using dumpcap */
+/**
+ * Set wireless channel using dumpcap
+ * On success, *data points to a buffer containing the dumpcap output,
+ * *primary_msg and *secondary_msg are NULL, and 0 is returned. *data
+ * must be freed with g_free().
+ *
+ * On failure, *data is NULL, *primary_msg points to an error message,
+ * *secondary_msg either points to an additional error message or is
+ * NULL, and -1 or errno value is returned; *primary_msg, and
+ * *secondary_msg if not NULL must be freed with g_free().
+ *
+ * @param iface (monitor) network interface name
+ * @param freq channel control frequency string (in MHz)
+ * @param type channel type string (or NULL if not used)
+ * @param center_freq1 VHT channel center frequency (or NULL if not used)
+ * @param center_freq2 VHT channel center frequency 2 (or NULL if not used)
+ * @return 0 on success
+ */
extern int
sync_interface_set_80211_chan(const gchar *iface, const char *freq, const gchar *type,
const gchar *center_freq1, const gchar *center_freq2,