DBgetVariableLong

Top  Previous  Next

An initialization variable as stands in investigate.

In the data bank initialized variables can be stored. The values are given with the function InitializeParameter/INI at user level. The values with DBsetInitialValue... or with DBsetVariable... are put on programmer's level. DBsetVariableLong writes such an initialization in the data bank. With the routine DBgetVariableLong the value can be determined again.

Parametre

root (PROOT) [IN]

Act on the open data bank.

name (char *) [IN]

Sign chain gives the name under which the variable is filed.

dfault (LONG) [IN]

If under the variable name name no value could be found, this value is delivered as a spare value.

art (int) [IN]

About the Flags in art the access to the variable should be steered. At the moment it is not implemented yet. There are three constants which regulate the kind of the access. Variables can be put worldwide, i.e. they are freely accessible. Variables can be put as hidden, i.e. they are not visible at the user level (with the user function InitializeParameter). Or they are put as local, then they are visible only for single functions.

Result

(long) [OUT]

The value which was stored in the variables name is delivered. If no variable with the name name could be found, the value dfault is delivered as a spare value.

Declaration

#include "database.h"

 

long DLLENTRY DBgetVariableLong (

PROOT root,

char * name,

LONG dfault,

int art

);

Constants

VAR_ART_LOCAL

VAR_ART_GLOBAL

VAR_ART_HIDDEN

Related functions

DBsetVariableLong