GRASS GIS 8 Programmer's Manual  8.5.0dev(2024)-d6dec75dd4
ret_codes.c File Reference

DBMI Library (base) - return codes (internal use only) More...

#include <stdlib.h>
#include <grass/dbmi.h>
#include "macros.h"
Include dependency graph for ret_codes.c:

Go to the source code of this file.

Functions

int db__send_success (void)
 Send success code. More...
 
int db__send_failure (void)
 Send failure code. More...
 
int db__recv_return_code (int *ret_code)
 Receive return code. More...
 

Detailed Description

DBMI Library (base) - return codes (internal use only)

Todo:
Are we as restrictive here as for vector names?

(C) 1999-2009, 2011 by the GRASS Development Team

This program is free software under the GNU General Public License (>=v2). Read the file COPYING that comes with GRASS for details.

Author
Joel Jones (CERL/UIUC), Radim Blazek
Doxygenized by Martin Landa <landa.martin gmail.com> (2011)

Definition in file ret_codes.c.

Function Documentation

◆ db__recv_return_code()

int db__recv_return_code ( int *  ret_code)

Receive return code.

Parameters
[out]ret_codereturn code
Returns
DB_OK on success

Definition at line 51 of file ret_codes.c.

◆ db__send_failure()

int db__send_failure ( void  )

Send failure code.

Returns
DB_OK

Definition at line 37 of file ret_codes.c.

References DB_FAILED, db_get_error_msg(), DB_OK, DB_SEND_C_STRING, and DB_SEND_INT.

◆ db__send_success()

int db__send_success ( void  )

Send success code.

Returns
DB_OK

Definition at line 26 of file ret_codes.c.

References DB_OK, and DB_SEND_INT.