summaryrefslogtreecommitdiff
path: root/libgps.xml
diff options
context:
space:
mode:
Diffstat (limited to 'libgps.xml')
-rw-r--r--libgps.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/libgps.xml b/libgps.xml
index eccc66d1..b70f3a67 100644
--- a/libgps.xml
+++ b/libgps.xml
@@ -47,6 +47,10 @@ C:
<paramdef>int <parameter>timeout</parameter></paramdef>
</funcprototype>
<funcprototype>
+<funcdef>void <function>gps_data</function></funcdef>
+ <paramdef>struct gps_data_t *<parameter>gpsdata</parameter></paramdef>
+</funcprototype>
+<funcprototype>
<funcdef>void <function>gps_close</function></funcdef>
<paramdef>struct gps_data_t *<parameter>gpsdata</parameter></paramdef>
</funcprototype>
@@ -140,6 +144,10 @@ will not supply input often enough to prevent a spurious error indication.
For the typical 1-second cycle time of GPSes this implies a minimum 2-second
timeout.</para>
+<para><function>gps_data()</function> returns the contents of the
+client data buffer. Use with care; this may fail to be a NUL-terminated
+string if WATCH_RAW is enabled.</para>
+
<para><function>gps_stream()</function> asks
<application>gpsd</application> to stream the reports it has at you,
to be made available when you poll. It is preferable to the