GRASS GIS 8 Programmer's Manual  8.2.2dev(2023)-3d2c704037
c_desc_table.c
Go to the documentation of this file.
1 /*!
2  * \file db/dbmi_client/c_desc_table.c
3  *
4  * \brief DBMI Library (client) - describe table
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 <grass/dbmi.h>
16 #include "macros.h"
17 
18 /*!
19  \brief Describe table
20 
21  \param driver db driver
22  \param name table name
23  \param[out] table pointer to dbTable structure
24 
25  \return DB_OK on success
26  \return DB_FAILED on failure
27  */
29 {
30  int ret_code;
31 
32  /* start the procedure call */
33  db__set_protocol_fds(driver->send, driver->recv);
35 
36  /* send the argument(s) to the procedure */
37  DB_SEND_STRING(name);
38 
39  /* get the return code for the procedure call */
40  DB_RECV_RETURN_CODE(&ret_code);
41 
42  if (ret_code != DB_OK)
43  return ret_code; /* ret_code SHOULD == DB_FAILED */
44 
45  /* get the results */
47  return DB_OK;
48 }
#define DB_PROC_DESCRIBE_TABLE
Definition: dbmi.h:54
int db_describe_table(dbDriver *driver, dbString *name, dbTable **table)
Describe table.
Definition: c_desc_table.c:28
#define DB_START_PROCEDURE_CALL(x)
Definition: macros.h:2
#define DB_RECV_TABLE_DEFINITION(x)
Definition: macros.h:64
#define DB_RECV_RETURN_CODE(x)
Definition: macros.h:4
#define DB_SEND_STRING(x)
Definition: macros.h:12
Definition: driver.h:22
FILE * recv
Definition: dbmi.h:171
const char * name
Definition: named_colr.c:7
void db__set_protocol_fds(FILE *, FILE *)
?
FILE * send
Definition: dbmi.h:171
#define DB_OK
Definition: dbmi.h:71