BrokerConnection functions are mostly used for accessing the broker connections log. The log is used for logging various broker connection events, such as connections, disconnections, order submissions, order acknowledgements, order cancellations and order modifications, among others.


Sections


Functions

Function Details


Functions


Name

Description

bool BrokerConnectionIsConnected()

Determines whether the broker connection for the Desktop is connected.

string BrokerConnectionMessage(int)

Gets the message of a specified broker connection log message.

int BrokerConnectionMessageCount()

Gets the number of broker connection log messages.

long BrokerConnectionMessageDateTime(int)

Gets the date/time of a specified broker connection log message.

int BrokerConnectionMessageSymbolIndex(int)

Gets the symbol index of a specified broker connection log message.

C_MessageType BrokerConnectionMessageType(int)

Gets the message type of a specified broker connection log message.


Function Details


bool BrokerConnectionIsConnected()

Determines whether the broker connection for the Desktop is connected.


Returns


True if the broker connection is connected, false otherwise.


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy


string BrokerConnectionMessage(int index)

Gets the message of a specified broker connection log message.


Returns


The message of the specified broker connection log message.


Parameters


Type

Identifier

Description

int

index

The broker connection log message index


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy


int BrokerConnectionMessageCount()

Gets the number of broker connection log messages.


Returns


The number of broker connection log messages.


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy


long BrokerConnectionMessageDateTime(int index)

Gets the date/time of a specified broker connection log message.


Returns


The date/time of the specified broker connection log message.


Parameters


Type

Identifier

Description

int

index

The broker connection log message index


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy


int BrokerConnectionMessageSymbolIndex(int index)

Gets the symbol index of a specified broker connection log message.


Returns


The symbol index of the specified broker connection log message.


Parameters


Type

Identifier

Description

int

index

The broker connection log message index


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy


C_MessageType BrokerConnectionMessageType(int index)

Gets the message type of a specified broker connection log message.


Returns


The message type of the specified broker connection log message. (View Options)


Parameters


Type

Identifier

Description

int

index

The broker connection log message index


Scripts


MultiSymbolTradingStrategy, Screener, TradingStrategy