GRASS GIS 7 Programmer's Manual  7.7.svn(2018)-r73587
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
c_close_cur.c
Go to the documentation of this file.
1 /*!
2  * \file db/dbmi_client/c_close_cur.c
3  *
4  * \brief DBMI Library (client) - close cursor
5  *
6  * (C) 1999-2008 by the GRASS Development Team
7  *
8  * This program is free software under the GNU General Public
9  * License (>=v2). Read the file COPYING that comes with GRASS
10  * for details.
11  *
12  * \author Joel Jones (CERL/UIUC), Radim Blazek
13  */
14 
15 #include <stdlib.h>
16 #include <grass/dbmi.h>
17 #include "macros.h"
18 
19 /*!
20  \brief Close cursor
21 
22  \param cursor cursor to be close
23 
24  \return DB_OK on success
25  \return DB_FAILED on failure
26 */
28 {
29  int ret_code;
30 
31  /* start the procedure call */
32  db__set_protocol_fds(cursor->driver->send, cursor->driver->recv);
34 
35  /* send the argument(s) to the procedure */
36  DB_SEND_TOKEN(&cursor->token);
37 
38  /* get the return code for the procedure call */
39  DB_RECV_RETURN_CODE(&ret_code);
40 
41  if (ret_code != DB_OK)
42  return ret_code; /* ret_code SHOULD == DB_FAILED */
43 
44  db_free_cursor(cursor);
45 
46  /* no results */
47  return DB_OK;
48 }
int db_close_cursor(dbCursor *cursor)
Close cursor.
Definition: c_close_cur.c:27
dbDriver * driver
Definition: dbmi.h:233
#define DB_START_PROCEDURE_CALL(x)
Definition: macros.h:2
#define DB_RECV_RETURN_CODE(x)
Definition: macros.h:4
dbToken token
Definition: dbmi.h:232
void db_free_cursor(dbCursor *cursor)
Free allocated dbCursor.
Definition: cursor.c:51
void db__set_protocol_fds(FILE *send, FILE *recv)
?
FILE * recv
Definition: dbmi.h:171
#define DB_SEND_TOKEN(x)
Definition: macros.h:97
#define DB_PROC_CLOSE_CURSOR
Definition: dbmi.h:37
FILE * send
Definition: dbmi.h:171
#define DB_OK
Definition: dbmi.h:71