d_desc_table.c

Go to the documentation of this file.

/*!
 * \file db/dbmi_driver/d_desc_table.c
 *
 * \brief DBMI Library (driver) - describe table
 *
 * SPDX-FileCopyrightText: 1999-2008 GRASS Development Team
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * \author Joel Jones (CERL/UIUC), Radim Blazek
 */
 
#include <stdlib.h>
#include <grass/dbmi.h>
#include "macros.h"
#include "dbstubs.h"
 
/*!
   \brief Describe table
 
   \return DB_OK on success
   \return DB_FAILED on failure
 */
int db_d_describe_table(void)
{
    dbTable *table;
    dbString name;
    int stat;
 
    db_init_string(&name);
 
    /* get the arg(s) */
    DB_RECV_STRING(&name);
 
    /* call the procedure */
    stat = db_driver_describe_table(&name, &table);
 
    /* send the return code */
    if (stat != DB_OK) {
        DB_SEND_FAILURE();
        return DB_OK;
    }
    DB_SEND_SUCCESS();
 
    /* results */
    db_set_table_name(table, db_get_string(&name));
    DB_SEND_TABLE_DEFINITION(table);
 
    db_free_string(&name);
    db_free_table(table);
    return DB_OK;
}