Home > Reference > Functions > Database > GetCampaignDBName

GetCampaignDBName()

Return the name of the campaign database that should be used for this module (or a default value if none).

string GetCampaignDBName();

Description

Return the name of the campaign database that should be used for this module (or a default value if none).

Remarks

If the variable X0_CAMPAIGN_DB is set on the module with a string, that string will be returned.

Otherwise it will check for if the module tag is one of the following: x0_module1, x0_module2, x0_module3, x0_module3e. If it is, X0_DATABASE_XP1 is returned.

Failing the above check the default DB name of X0_DATABASE_DEFAULT will be returned.

Whichever of these three database names is returned is then saved in a local string on the module called X0_CAMPAIGN_DB.

Requirements

#include "x0_i0_campaign"

Version

???

See Also

categories:

Database Functions

---

author: Baragg, editor: Mistress