class IO2GSystemPropertiesReader

Parents
IAddRef

Brief

A reader of the system properties.

Details

IO2GSystemPropertiesReader [hide]

 IO2GResponse *response = loginRules->getSystemPropertiesResponse();
 IO2GResponseReaderFactory *factory = mSession->getResponseReaderFactory();
 if (factory == NULL)
    return;
 IO2GSystemPropertiesReader *systemResponseReader = factory->createSystemPropertiesReader(response);
 if (systemResponseReader == NULL)
 {
    factory->release();
    return;
 }
 char buffer[512];
 sprintf_s(buffer, sizeof(buffer), "System Properties:");
 mLog->logString(buffer);
 for (int i = 0 ; i < systemResponseReader->size(); i++)
 {
    const char *value;
    const char *sysProperty = systemResponseReader->getProperty(i, value);
    sprintf_s(buffer, sizeof(buffer), "%s %s", sysProperty, value);
    mLog->logString(buffer);
 }
 systemResponseReader->release();
 factory->release();
 response->release();

To create IO2GSystemPropertiesReader use IO2GResponseReaderFactory.createSystemPropertiesReader

The properties are available immediately after login.

Property name

Description

BASE_CRNCY

The property contains the currency symbol of the base currency of the system. The base currency is the currency of the account. Margin requirements, profit/loss, account balance and equity are also expressed in the base currency units. Example of the value: USD.

BASE_CRNCY_PRECISION

The property contains the precision of the base currency. The precision is a number of significant digits after the decimal point. The property is useful for the formatting and rounding operations. Example of the value: 2 for USD, 0 for JPY.

BASE_CRNCY_SYMBOL

The property contains the currency symbol of the base currency of the system. Example: $ for USD.

BASE_TIME_ZONE

The property contains the name of the time zone of the server. The list of time zone names can be found here. Please note that the server can send the time either in the UTC or in the server time zone. Please also check the SERVER_TIME_UTC property.

BASE_UNIT_SIZE

The size of one lot, i.e. the minimum amount per trade that is allowed in the system. The amount is expressed in the base currency of the instrument (for example, if the value is 1,000, one lot for EUR/USD is 1,000 Euros, for USD/JPY - 1,000 US dollars, etc). The total amount of the trade must consist of a whole number of lots.

SERVER_TIME_UTC

The value of the property equals "UTC" in case the server sends time as UTC time. In case the value is not equal to "UTC", the server sends time in the local time zone of the server. The local time zone of the server can be checked in the BASE_TIME_ZONE property.

COND_DIST

The property contains the minimal recommended distance between the rates of the stop or limit and the current market rate. The server can reject the stop or limit orders in case the distance is smaller. The distance is expressed in pips.

Backwards compatibility is available for Forex-Only accounts.

COND_DIST_ENTRY

The property contains the minimal recommended distance between the rates of the entry order and the current market rate. The server can reject the order in case the distance is smaller. The distance is expressed in pips.

Backwards compatibility is available for Forex-Only accounts.

END_TRADING_DAY

The property contains the time of the end of a trading day. The time is expressed in the format hh:mm:ss, where hh is hour in 24-hour format, mm is minutes and ss is seconds. The time is in the UTC time zone.

FORCE_PASSWORD_CHANGE

The property contains "Y" in case the user password is expired and must be changed immediately.

MARKET_OPEN

The property shows whether the market is currently open. The property contains Y in case the market is open and N in case the market is closed.

TRAILING_DYNAMIC

The property shows whether the server supports dynamic trailing. This mode is set for the whole server and cannot be modified for a particular user or account.

In case the value of this parameter is "Y", the TrailStep parameter of the methods related to orders acts as a simple Boolean flag. In case the TrailStep parameter does not equal zero the order is a trailing order. In case the TrailStep parameter equals zero, the order is not a trailing order.

In case the value of this parameter is "N", the TrailStep parameter defines the minimal movement of the order rate expressed in pips.

TRAILING_FLUCTUATE_PTS_MAX

The property contains the maximal value of the trailing minimal move. The server can reject orders in case the trailing move distance is bigger than the specified value. The value is expressed in pips.

TRAILING_FLUCTUATE_PTS_MIN

The property contains the minimal value of the trailing minimal move. The server can reject orders in case the trailing move distance is smaller than the specified value. The value is expressed in pips.

TRAILING_FLUCTUATE

The property shows whether the trailing mode is supported. In case the value of this property does not equal "Y", trailing orders must not be used at all.

PEGGED_STOP_LIMIT_DISABLED

The property shows whether the server supports Pegged Stop/Limit orders. If the value of this parameter is "Y", Pegged Stop/Limit orders are not supported. If the value of this parameter is "N", Pegged Stop/Limit orders are supported. In case the property does not exist, pegged stop/limits are enabled.

TP_86 or CP_86

The property shows whether the user may create, change, delete entry orders, link entry orders to an OCO order, add and remove entry orders from an OCO order. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_88 or CP_88

The property shows whether the user may open and close trades. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_89 or CP_89

The property shows whether the user may change the subscription for currencies. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_94 or CP_94

The property shows whether the user may create, change and delete stop and limit orders. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_170 or CP_170

The property shows whether the user may close opposite positions by each other when hedging is allowed. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_171 or CP_171

The property shows whether the user may open and close positions using opening orders. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

TP_172 or CP_172

The property shows whether the user may close positions using closing orders. The user may in case the value of the property equals "Y". Only one of these properties is available depending on the kind of the user: TP_ is available for a trader and CP_ is available for a customer.

Backwards compatibility is available for Forex-Only accounts.

SupportTickVolume

The property shows whether the tick volume is supported. In case the value of this property does not equal "Y", the tick volume is not available.

QUERYDEPTH_0

The property contains the maximal number of periods that can be retrieved for a chart with the Tick period. If the property does not exist, the Tick period is not supported.

QUERYDEPTH_1

The property contains the maximal number of periods that can be retrieved for a chart with the m1 period. If the property does not exist, the m1 period is not supported.

QUERYDEPTH_2

The property contains the maximal number of periods that can be retrieved for a chart with the m5 period. If the property does not exist, the m5 period is not supported.

QUERYDEPTH_3

The property contains the maximal number of periods that can be retrieved for a chart with the m15 period. If the property does not exist, the m15 period is not supported.

QUERYDEPTH_4

The property contains the maximal number of periods that can be retrieved for a chart with the m30 period. If the property does not exist, the m30 period is not supported.

QUERYDEPTH_5

The property contains the maximal number of periods that can be retrieved for a chart with the h1 period. If the property does not exist, the h1 period is not supported.

QUERYDEPTH_6

The property contains the maximal number of periods that can be retrieved for a chart with the d1 period. If the property does not exist, the d1 period is not supported.

QUERYDEPTH_7

The property contains the maximal number of periods that can be retrieved for a chart with the w1 period. If the property does not exist, the w1 period is not supported

QUERYDEPTH_8

The property contains the maximal number of periods that can be retrieved for a chart with the M1 period. If the property does not exist, the M1 period is not supported.

QUERYDEPTH_h2

The property contains the maximal number of periods that can be retrieved for a chart with the h2 period. If the property does not exist, the h2 period is not supported.

QUERYDEPTH_h3

The property contains the maximal number of periods that can be retrieved for a chart with the h3 period. If the property does not exist, the h3 period is not supported.

QUERYDEPTH_h4

The property contains the maximal number of periods that can be retrieved for a chart with the h4 period. If the property does not exist, the h4 period is not supported.

QUERYDEPTH_h6

The property contains the maximal number of periods that can be retrieved for a chart with the h6 period. If the property does not exist, the h6 period is not supported.

QUERYDEPTH_h8

The property contains the maximal number of periods that can be retrieved for a chart with the h8 period. If the property does not exist, the h8 period is not supported.

Public Methods

findProperty

Finds a property by name.

getProperty

Gets a property by index.

size

Gets the number of properties in the system.

back