annotate main/database/src/pq_close.cc @ 11432:4d28b9a2d388 octave-forge

Fix some documentation for initial release of new package.
author i7tiol
date Sun, 03 Feb 2013 10:55:31 +0000
parents 9aee227e296c
children 2257648e8ce1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11394
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
1 /*
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
2
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
3 Copyright (C) 2012 Olaf Till <i7tiol@t-online.de>
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
4
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
5 This program is free software; you can redistribute it and/or modify
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
8 (at your option) any later version.
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
9
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
13 GNU General Public License for more details.
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
14
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
16 along with this program; If not, see <http://www.gnu.org/licenses/>.
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
17
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
18 */
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
19
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
20 #include <octave/oct.h>
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
21
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
22 #include "pq_connection.h"
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
23
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
24 // PKG_ADD: autoload ("pq_close", "pq_interface.oct");
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
25
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
26 DEFUN_DLD (pq_close, args, ,
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
27 "-*- texinfo -*-\n\
11432
4d28b9a2d388 Fix some documentation for initial release of new package.
i7tiol
parents: 11394
diff changeset
28 @deftypefn {Loadable Function} pq_close (@var{connection})\n\
4d28b9a2d388 Fix some documentation for initial release of new package.
i7tiol
parents: 11394
diff changeset
29 Closes connection @var{connection} to a postgresql server.\n\
4d28b9a2d388 Fix some documentation for initial release of new package.
i7tiol
parents: 11394
diff changeset
30 @seealso{pq_connect}\n\
11394
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
31 @end deftypefn")
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
32 {
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
33 std::string fname ("pq_close");
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
34
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
35 if (args.length () != 1 ||
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
36 args(0).type_id () != octave_pq_connection::static_type_id ())
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
37 {
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
38 print_usage ();
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
39
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
40 return octave_value_list ();
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
41 }
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
42
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
43 octave_base_value& rep = const_cast<octave_base_value&> (args(0).get_rep ());
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
44
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
45 octave_pq_connection &oct_pq_conn = dynamic_cast<octave_pq_connection&> (rep);
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
46
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
47 oct_pq_conn.octave_pq_close ();
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
48
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
49 return octave_value_list ();
9aee227e296c Populated new database package with initial postgresql interface.
i7tiol
parents:
diff changeset
50 }