ESS_VARIABLE_T is the primary substitution variable datatype. It identifies the substitution variable's value and name, as well as the Essbase database, application, and server where the variable is defined.
The Server name is optional, but recommended. If not included, the current server is the default. The AppName is optional. The DbName is optional, but if it exists, then the AppName member is required. The VarName is required. The VarValue is required.
typedef struct ESS_VARIABLE_T { ESS_SVRNAME_T Server; ESS_APPNAME_T AppName; ESS_DBNAME_T DbName; ESS_MBRNAME_T VarName; ESS_CHAR_T VarValue[ESS_VARVALUELEN]; } ESS_VARIABLE_T, *ESS_PVARIABLE_T, **ESS_PPVARIABLE_T;
Data Type | Field | Description |
---|---|---|
ESS_SVRNAME_T | Server | Name of server where variable is defined (optional) |
ESS_APPNAME_T | AppName | Name of application to restrict variable to |
ESS_DBNAME_T | DbName | Name of database to restrict variable to. If used, it requires that application be set. |
ESS_MBRNAME_T | VarName | Name of substitution variable. |
ESS_CHAR_T | VarValue[256] | Value of substitution variable. |