aboutsummaryrefslogtreecommitdiff
path: root/man/dbfp_close.pod
diff options
context:
space:
mode:
authorRobin Krahl <me@robin-krahl.de>2016-06-06 18:20:10 +0200
committerRobin Krahl <me@robin-krahl.de>2016-06-06 18:20:10 +0200
commitc96d948a4b76875c91848518aa2f55f2774a4118 (patch)
treefee967f78c6730df109682ade852f295c0b1dab0 /man/dbfp_close.pod
parent1f0c7d966fdb31f62cf40eac9c39ae2b9e643366 (diff)
downloaddbfp-c96d948a4b76875c91848518aa2f55f2774a4118.tar.gz
dbfp-c96d948a4b76875c91848518aa2f55f2774a4118.tar.bz2
dbfp: add man pages for dbfp_init, dbfp_close
Diffstat (limited to 'man/dbfp_close.pod')
-rw-r--r--man/dbfp_close.pod27
1 files changed, 27 insertions, 0 deletions
diff --git a/man/dbfp_close.pod b/man/dbfp_close.pod
new file mode 100644
index 0000000..6d63bb0
--- /dev/null
+++ b/man/dbfp_close.pod
@@ -0,0 +1,27 @@
+=head1 NAME
+
+dbfp_close - cleans up the metadata for queries to the DB timetable API
+
+=head1 SYNOPSIS
+
+ #include <dbfp.h>
+
+ void dbfp_close(struct dbfp *dbfp);
+
+=head1 DESCRIPTION
+
+B<dbfp_close> cleans up a I<dbfp> structure and releases its allocated
+resources. The structure itself is not freed. I<dbfp> may be NULL.
+
+B<dbfp> is a structure defined as:
+
+ struct dbfp {
+ char *key;
+ CURL *curl;
+ };
+
+The user does not have to deal with the fields of this structure.
+
+=head1 SEE ALSO
+
+L<dbfp_init(3)>