GRASS GIS 8 Programmer's Manual  8.4.0dev(2024)-dd1a9b617b
Macros
macros.h File Reference

Go to the source code of this file.

Macros

#define DB_RETURN_ERR   return (db_get_error_code());
 
#define DB_START_PROCEDURE_CALL(x)
 
#define DB_RECV_RETURN_CODE(x)
 
#define DB_SEND_SUCCESS()
 
#define DB_SEND_FAILURE()
 
#define DB_SEND_STRING(x)
 
#define DB_SEND_STRING_ARRAY(x, n)
 
#define DB_SEND_C_STRING(x)
 
#define DB_RECV_STRING(x)
 
#define DB_RECV_STRING_ARRAY(x, n)
 
#define DB_SEND_CHAR(x)
 
#define DB_RECV_CHAR(x)
 
#define DB_SEND_SHORT(x)
 
#define DB_RECV_SHORT(x)
 
#define DB_SEND_SHORT_ARRAY(x, n)
 
#define DB_RECV_SHORT_ARRAY(x, n)
 
#define DB_SEND_INT(x)
 
#define DB_RECV_INT(x)
 
#define DB_SEND_FLOAT(x)
 
#define DB_RECV_FLOAT(x)
 
#define DB_SEND_DOUBLE(x)
 
#define DB_RECV_DOUBLE(x)
 
#define DB_SEND_DATETIME(x)
 
#define DB_RECV_DATETIME(x)
 
#define DB_SEND_HANDLE(x)
 
#define DB_RECV_HANDLE(x)
 
#define DB_SEND_TABLE_DEFINITION(x)
 
#define DB_RECV_TABLE_DEFINITION(x)
 
#define DB_SEND_TABLE_DATA(x)
 
#define DB_RECV_TABLE_DATA(x)
 
#define DB_SEND_TABLE_PRIV(x)
 
#define DB_RECV_TABLE_PRIV(x)
 
#define DB_SEND_COLUMN_PRIVS(x)
 
#define DB_RECV_COLUMN_PRIVS(x)
 
#define DB_SEND_COLUMN_DEFINITION(x)
 
#define DB_RECV_COLUMN_DEFINITION(x)
 
#define DB_SEND_COLUMN_VALUE(x)
 
#define DB_RECV_COLUMN_VALUE(x)
 
#define DB_SEND_COLUMN_DEFAULT_VALUE(x)
 
#define DB_RECV_COLUMN_DEFAULT_VALUE(x)
 
#define DB_SEND_TOKEN(x)
 
#define DB_RECV_TOKEN(x)
 
#define DB_SEND_INDEX(x)
 
#define DB_SEND_INDEX_ARRAY(x, n)
 
#define DB_RECV_INDEX(x)
 
#define DB_RECV_INDEX_ARRAY(x, n)
 
#define DB_SEND_FK(x)
 
#define DB_SEND_FK_ARRAY(x, n)
 
#define DB_RECV_FK(x)
 
#define DB_RECV_FK_ARRAY(x, n)
 

Macro Definition Documentation

◆ DB_RECV_CHAR

#define DB_RECV_CHAR (   x)
Value:
{ \
if (db__recv_char(x) != DB_OK) \
DB_RETURN_ERR \
}
DB_OK
#define DB_OK
Definition: dbmi.h:71
db__recv_char
int db__recv_char(char *)
?
Definition: xdrchar.c:45
x
#define x

Definition at line 55 of file macros.h.

◆ DB_RECV_COLUMN_DEFAULT_VALUE

#define DB_RECV_COLUMN_DEFAULT_VALUE (   x)
Value:
{ \
if (db__recv_column_default_value(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_column_default_value
int db__recv_column_default_value(dbColumn *)
Receive column default value.
Definition: xdrcolumn.c:120

Definition at line 208 of file macros.h.

◆ DB_RECV_COLUMN_DEFINITION

#define DB_RECV_COLUMN_DEFINITION (   x)
Value:
{ \
if (db__recv_column_definition(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_column_definition
int db__recv_column_definition(dbColumn *)
Receive column definition.
Definition: xdrcolumn.c:53

Definition at line 186 of file macros.h.

◆ DB_RECV_COLUMN_PRIVS

#define DB_RECV_COLUMN_PRIVS (   x)
Value:
{ \
if (db__recv_column_privs(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 175 of file macros.h.

◆ DB_RECV_COLUMN_VALUE

#define DB_RECV_COLUMN_VALUE (   x)
Value:
{ \
if (db__recv_column_value(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_column_value
int db__recv_column_value(dbColumn *)
Receive column value.
Definition: xdrcolumn.c:94

Definition at line 197 of file macros.h.

◆ DB_RECV_DATETIME

#define DB_RECV_DATETIME (   x)
Value:
{ \
if (db__recv_datetime(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_datetime
int db__recv_datetime(dbDateTime *)
Receive datetime.
Definition: xdrdatetime.c:47

Definition at line 120 of file macros.h.

◆ DB_RECV_DOUBLE

#define DB_RECV_DOUBLE (   x)
Value:
{ \
if (db__recv_double(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_double
int db__recv_double(double *)
Receive double.
Definition: xdrdouble.c:42

Definition at line 109 of file macros.h.

◆ DB_RECV_FK

#define DB_RECV_FK (   x)
Value:
{ \
if (db__recv_fk(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 256 of file macros.h.

◆ DB_RECV_FK_ARRAY

#define DB_RECV_FK_ARRAY (   x,
  n 
)
Value:
{ \
if (db__recv_fk_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 261 of file macros.h.

◆ DB_RECV_FLOAT

#define DB_RECV_FLOAT (   x)
Value:
{ \
if (db__recv_float(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_float
int db__recv_float(float *)
Receive float.
Definition: xdrfloat.c:44

Definition at line 98 of file macros.h.

◆ DB_RECV_HANDLE

#define DB_RECV_HANDLE (   x)
Value:
{ \
if (db__recv_handle(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_handle
int db__recv_handle(dbHandle *)
Receive handle.
Definition: xdrhandle.c:40

Definition at line 131 of file macros.h.

◆ DB_RECV_INDEX

#define DB_RECV_INDEX (   x)
Value:
{ \
if (db__recv_index(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_index
int db__recv_index(dbIndex *)
Receive index.
Definition: xdrindex.c:68

Definition at line 235 of file macros.h.

◆ DB_RECV_INDEX_ARRAY

#define DB_RECV_INDEX_ARRAY (   x,
  n 
)
Value:
{ \
if (db__recv_index_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_index_array
int db__recv_index_array(dbIndex **, int *)
Receive index array.
Definition: xdrindex.c:95

Definition at line 240 of file macros.h.

◆ DB_RECV_INT

#define DB_RECV_INT (   x)
Value:
{ \
if (db__recv_int(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_int
int db__recv_int(int *)
Receive integer.
Definition: xdrint.c:44

Definition at line 87 of file macros.h.

◆ DB_RECV_RETURN_CODE

#define DB_RECV_RETURN_CODE (   x)
Value:
{ \
if (db__recv_return_code(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_return_code
int db__recv_return_code(int *)
Receive return code.
Definition: ret_codes.c:51

Definition at line 7 of file macros.h.

◆ DB_RECV_SHORT

#define DB_RECV_SHORT (   x)
Value:
{ \
if (db__recv_short(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_short
int db__recv_short(short *)
Receive short.
Definition: xdrshort.c:46

Definition at line 66 of file macros.h.

◆ DB_RECV_SHORT_ARRAY

#define DB_RECV_SHORT_ARRAY (   x,
  n 
)
Value:
{ \
if (db__recv_short_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_short_array
int db__recv_short_array(short **, int *)
Receive short array.
Definition: xdrshort.c:94

Definition at line 76 of file macros.h.

◆ DB_RECV_STRING

#define DB_RECV_STRING (   x)
Value:
{ \
if (db__recv_string(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_string
int db__recv_string(dbString *)
Reads a string from transport.
Definition: xdrstring.c:117

Definition at line 39 of file macros.h.

◆ DB_RECV_STRING_ARRAY

#define DB_RECV_STRING_ARRAY (   x,
  n 
)
Value:
{ \
if (db__recv_string_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_string_array
int db__recv_string_array(dbString **, int *)
Receive string array.
Definition: xdrstring.c:46

Definition at line 44 of file macros.h.

◆ DB_RECV_TABLE_DATA

#define DB_RECV_TABLE_DATA (   x)
Value:
{ \
if (db__recv_table_data(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_table_data
int db__recv_table_data(dbTable *)
Receive table data.
Definition: xdrtable.c:101

Definition at line 153 of file macros.h.

◆ DB_RECV_TABLE_DEFINITION

#define DB_RECV_TABLE_DEFINITION (   x)
Value:
{ \
if (db__recv_table_definition(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_table_definition
int db__recv_table_definition(dbTable **)
Receive table definition.
Definition: xdrtable.c:51

Definition at line 142 of file macros.h.

◆ DB_RECV_TABLE_PRIV

#define DB_RECV_TABLE_PRIV (   x)
Value:
{ \
if (db__recv_table_priv(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 164 of file macros.h.

◆ DB_RECV_TOKEN

#define DB_RECV_TOKEN (   x)
Value:
{ \
if (db__recv_token(x) != DB_OK) \
DB_RETURN_ERR \
}
db__recv_token
int db__recv_token(dbToken *)
Receive token.
Definition: xdrtoken.c:36

Definition at line 219 of file macros.h.

◆ DB_RETURN_ERR

#define DB_RETURN_ERR   return (db_get_error_code());

Definition at line 1 of file macros.h.

◆ DB_SEND_C_STRING

#define DB_SEND_C_STRING (   x)
Value:
{ \
if (db__send_Cstring(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_Cstring
int db__send_Cstring(const char *)
Send C string.
Definition: xdrstring.c:150

Definition at line 34 of file macros.h.

◆ DB_SEND_CHAR

#define DB_SEND_CHAR (   x)
Value:
{ \
if (db__send_char(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_char
int db__send_char(int)
?
Definition: xdrchar.c:24

Definition at line 50 of file macros.h.

◆ DB_SEND_COLUMN_DEFAULT_VALUE

#define DB_SEND_COLUMN_DEFAULT_VALUE (   x)
Value:
{ \
if (db__send_column_default_value(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_column_default_value
int db__send_column_default_value(dbColumn *)
Send column default value.
Definition: xdrcolumn.c:107

Definition at line 203 of file macros.h.

◆ DB_SEND_COLUMN_DEFINITION

#define DB_SEND_COLUMN_DEFINITION (   x)
Value:
{ \
if (db__send_column_definition(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_column_definition
int db__send_column_definition(dbColumn *)
Send column definition.
Definition: xdrcolumn.c:25

Definition at line 181 of file macros.h.

◆ DB_SEND_COLUMN_PRIVS

#define DB_SEND_COLUMN_PRIVS (   x)
Value:
{ \
if (db__send_column_privs(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 170 of file macros.h.

◆ DB_SEND_COLUMN_VALUE

#define DB_SEND_COLUMN_VALUE (   x)
Value:
{ \
if (db__send_column_value(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_column_value
int db__send_column_value(dbColumn *)
Send column value.
Definition: xdrcolumn.c:81

Definition at line 192 of file macros.h.

◆ DB_SEND_DATETIME

#define DB_SEND_DATETIME (   x)
Value:
{ \
if (db__send_datetime(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_datetime
int db__send_datetime(dbDateTime *)
Send datetime.
Definition: xdrdatetime.c:25

Definition at line 115 of file macros.h.

◆ DB_SEND_DOUBLE

#define DB_SEND_DOUBLE (   x)
Value:
{ \
if (db__send_double(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_double
int db__send_double(double)
Send double.
Definition: xdrdouble.c:24

Definition at line 104 of file macros.h.

◆ DB_SEND_FAILURE

#define DB_SEND_FAILURE ( )
Value:
{ \
if (db__send_failure() != DB_OK) \
DB_RETURN_ERR \
}
db__send_failure
int db__send_failure(void)
Send failure code.
Definition: ret_codes.c:37

Definition at line 18 of file macros.h.

◆ DB_SEND_FK

#define DB_SEND_FK (   x)
Value:
{ \
if (db__send_fk(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 246 of file macros.h.

◆ DB_SEND_FK_ARRAY

#define DB_SEND_FK_ARRAY (   x,
  n 
)
Value:
{ \
if (db__send_fk_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 251 of file macros.h.

◆ DB_SEND_FLOAT

#define DB_SEND_FLOAT (   x)
Value:
{ \
if (db__send_float(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_float
int db__send_float(float)
Send float.
Definition: xdrfloat.c:24

Definition at line 93 of file macros.h.

◆ DB_SEND_HANDLE

#define DB_SEND_HANDLE (   x)
Value:
{ \
if (db__send_handle(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_handle
int db__send_handle(dbHandle *)
Send handle.
Definition: xdrhandle.c:25

Definition at line 126 of file macros.h.

◆ DB_SEND_INDEX

#define DB_SEND_INDEX (   x)
Value:
{ \
if (db__send_index(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_index
int db__send_index(dbIndex *)
Send index.
Definition: xdrindex.c:25

Definition at line 225 of file macros.h.

◆ DB_SEND_INDEX_ARRAY

#define DB_SEND_INDEX_ARRAY (   x,
  n 
)
Value:
{ \
if (db__send_index_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__send_index_array
int db__send_index_array(dbIndex *, int)
Send index array.
Definition: xdrindex.c:50

Definition at line 230 of file macros.h.

◆ DB_SEND_INT

#define DB_SEND_INT (   x)
Value:
{ \
if (db__send_int(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_int
int db__send_int(int)
Send integer.
Definition: xdrint.c:24

Definition at line 82 of file macros.h.

◆ DB_SEND_SHORT

#define DB_SEND_SHORT (   x)
Value:
{ \
if (db__send_short(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_short
int db__send_short(int)
Send short.
Definition: xdrshort.c:25

Definition at line 61 of file macros.h.

◆ DB_SEND_SHORT_ARRAY

#define DB_SEND_SHORT_ARRAY (   x,
  n 
)
Value:
{ \
if (db__send_short_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__send_short_array
int db__send_short_array(const short *, int)
Send short array.
Definition: xdrshort.c:67

Definition at line 71 of file macros.h.

◆ DB_SEND_STRING

#define DB_SEND_STRING (   x)
Value:
{ \
if (db__send_string(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_string
int db__send_string(dbString *)
Send string.
Definition: xdrstring.c:86

Definition at line 24 of file macros.h.

◆ DB_SEND_STRING_ARRAY

#define DB_SEND_STRING_ARRAY (   x,
  n 
)
Value:
{ \
if (db__send_string_array(x, n) != DB_OK) \
DB_RETURN_ERR \
}
db__send_string_array
int db__send_string_array(dbString *, int)
Send string array.
Definition: xdrstring.c:26

Definition at line 29 of file macros.h.

◆ DB_SEND_SUCCESS

#define DB_SEND_SUCCESS ( )
Value:
{ \
if (db__send_success() != DB_OK) \
DB_RETURN_ERR \
}
db__send_success
int db__send_success(void)
Send success code.
Definition: ret_codes.c:26

Definition at line 13 of file macros.h.

◆ DB_SEND_TABLE_DATA

#define DB_SEND_TABLE_DATA (   x)
Value:
{ \
if (db__send_table_data(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_table_data
int db__send_table_data(dbTable *)
Send table data.
Definition: xdrtable.c:81

Definition at line 148 of file macros.h.

◆ DB_SEND_TABLE_DEFINITION

#define DB_SEND_TABLE_DEFINITION (   x)
Value:
{ \
if (db__send_table_definition(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_table_definition
int db__send_table_definition(dbTable *)
Send table definition.
Definition: xdrtable.c:26

Definition at line 137 of file macros.h.

◆ DB_SEND_TABLE_PRIV

#define DB_SEND_TABLE_PRIV (   x)
Value:
{ \
if (db__send_table_priv(x) != DB_OK) \
DB_RETURN_ERR \
}

Definition at line 159 of file macros.h.

◆ DB_SEND_TOKEN

#define DB_SEND_TOKEN (   x)
Value:
{ \
if (db__send_token(x) != DB_OK) \
DB_RETURN_ERR \
}
db__send_token
int db__send_token(dbToken *)
Send token.
Definition: xdrtoken.c:24

Definition at line 214 of file macros.h.

◆ DB_START_PROCEDURE_CALL

#define DB_START_PROCEDURE_CALL (   x)
Value:
{ \
if (db__start_procedure_call(x) != DB_OK) \
DB_RETURN_ERR \
}
db__start_procedure_call
int db__start_procedure_call(int)
? (client only)
Definition: xdrprocedure.c:25

Definition at line 2 of file macros.h.