Knowledgebase
SYNTAX
Public sub AddLog(ByVal Entry As String)
DESCRIPTION
This method use to add String to the log.
PARAMETERS
Key
Description
Entry
The string that will add to the log
SAMPLE
Public Sub SymbolSettingSave ()
G...
SYNTAX
Public Function ExecuteNonQuery(ByVal CommandText As String)
DESCRIPTION
This method use to insert into database, update felids in database,
delete from database.
PARAMETERS
Key
Description
CommandText
insert, update, delete comm...
SYNTAX
Public Function ExecuteQuery (ByVal CommandText As String) As System.Data.DataRowCollection
DESCRIPTION
This method return the count of rows that selected from database.
PARAMETERS
Key
Description
CommandText
The select command
...
SYNTAX
Public Function SetLOAcceptAtOffsetSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of accepted limit order with
Sell type for a certain symbol.
PARAMETERS
Key
Descri...
SYNTAX
Public Function SetLOLOCoverOffsetSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the covered limit order with
Sell type for certain symbol if the “cover order as” option...
SYNTAX
Public Function SetLOBetterPipsSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the pips amount of the covered limit order with
sell type for certain symbol when the “Price Condition” option is
...
SYNTAX
Public Function GetLOAcceptAtOffsetSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the accepted limit order
with Sell type for certain symbol.
PARAMETERS
Key
Description
SymbolID
...
SYNTAX
Public Function GetLOLOCoverOffsetSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This Function returns the slippage of the covered limit order with
Sell type for certain symbol if the “Cover order as” option is set
to “Limit order with o...
SYNTAX
Public Function GetLOBetterPipsSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the pips amount of covered limit order with Sell
type for certain symbol when the “Price Condition” option is set
to “Cover when LP price...
SYNTAX
Public Function SetMOAcceptAtOffsetSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the accepted market order
with Sell type for certain symbol.
PARAMETERS
Key
Des...
SYNTAX
Public Function SetMOLOCoverOffsetSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the better pips amount of the covered market order
with Sell type for certain symbol when the “Price Condition”...
SYNTAX
Public Function SetMOBetterPipsSell(ByVal SymbolID As String,ByVal value As Integer) As TransResult
DESCRIPTION
This function sets the better pips amount of the covered market order
with Sell type for certain symbol when the “Price Condition”
op...
SYNTAX
Public Function GetMOAcceptAtOffsetSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This function return the slippage amount of accepted market order of
Sell type for certain Symbol.
PARAMETERS
Key
Description
SymbolID
ID of...
SYNTAX
Public Function GetMOLOCoverOffsetSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the covered market order
with Sell type for certain symbol if the “cover order as” option
is set to “limit order...
SYNTAX
Public Function GetMOBetterPipsSell(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the better pips amount of the covered market
order with sell type for certain symbol when the “Price Condition”
option is set to “cover wh...
SYNTAX
Public function HandleOrder(ByVal BOOrder As Order) As TransResult
DESCRIPTION
This sub procedure is used to send the BackOffice order to the Bridge
chatting screen.
PARAMETERS
Key
Description
BOOrder
The Object of the Order
[htt...
SYNTAX
Public Function Symbol(ByVal Name As String) As Symbol
Public Function Symbol(ByVal Index As Integer) As Symbol
DESCRIPTION
This function gets the symbol by its ID or returns the symbol by its
index.
Parameters
Key
Description
Name...
SYNTAX
Public Function GetLPs(ByVal LPDescreption As String) As Collection
DESCRIPTION
This function returns a collection of liquidity providers objects.
Parameters
Key
Description
LPDescreption
ID of the liquidity provider
RETURN V...
SYNTAX
Public Function GetLP(ByVal LPDescreption As String) As VertexFXBridgeAPI.VertexFXLP
DESCRIPTION
This function returns a certain liquidity provider object.
Parameters
Key
Description
LPDescreption
ID of the liquidity provider
...
SYNTAX
Public Function LPDisconnect(ByVal LPDescreption As String) As TransResult
DESCRIPTION
This function disconnects a certain liquidity provider.
Parameters
Key
Description
LPDescreption
ID of the liquidity provider
RETURN VALUE...
SYNTAX
Public Function LPConnect(ByVal LPDescreption As String) As TransResult
DESCRIPTION
This function connects a certain liquidity provider.
Parameters
Key
Description
LPDescreption
ID of the liquidity provider
RETURN VALUE
Retu...
SYNTAX
Public Function LPNewOrder(ByVal LPDescreption As String, ByVal BuySell As OperationType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal LPAccountID As String, ByVal BOOrderID As String) As TransResult
DESCRIPTION
This function crea...
SYNTAX
Public Function LPNewLimitOrder(ByVal LPDescreption As String, ByVal LOType As VertexFXBridgeAPI.LimitOrderType, ByVal Amount As Double, ByVal LPSymbolName As String, ByVal Price As Double, ByVal LPAccount As Long, ByVal BOOrderID As String) As Tr...
SYNTAX
Public Function SaveSymbolSettings(ByVal SymbolID As String) As TransResult
DESCRIPTION
This function saves the settings for a certain symbol.
Parameters
Key
Description
SymbolID
ID of the symbol
RETURN VALUE
Returns an inte...
SYNTAX
Public Function SetLOAcceptAtOffsetBuy(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the accepted limit order
with Buy type for a certain symbol.
Parameters
Key
Des...
SYNTAX
Public Function SetLOAcceptWithPrice(ByVal SymbolID As String, ByVal Value As AcceptOrderWithPrice) As TransResult
DESCRIPTION
This function set the accepted price type of the limit order for a
certain symbol.
Parameters
Key
Description ...
SYNTAX
Public Function SetLOLOCoverOffsetBuy(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the covered limit order for
a certain symbol if the "Cover order as" option is set to "L...
SYNTAX
Public Function SetLOCoverAs(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the covering type of the limit order for a certain
symbol.
Parameters
Key
Description
SymbolID
ID of the...
SYNTAX
Public Function SetLOCoverPercent(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the percentage amount of the covered limit order
for a certain symbol.
Parameters
Key
Description
Symb...
SYNTAX
Public Function SetLOBetterPipsBuy(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the pips amount of the covered limit order with Buy
type for a certain symbol when the "Price Condition" option is...
SYNTAX
Public Function SetLOSymbolPriceCondition(ByVal SymbolID As String, ByVal Value As WhenTOCover) As TransResult
DESCRIPTION
This function sets the price condition of the covered limit order for
a certain symbol.
Parameters
Key
Description...
SYNTAX
Public Function SetLOSymbolWaitingSeconds(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the waiting seconds for a certain symbol when
limit order will be covered.
Parameters
Key
Descripti...
SYNTAX
Public Function SetMOAcceptAtOffsetBuy(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the accepted market order
with Buy type for a certain symbol.
Parameters
Key
De...
SYNTAX
Public Function SetMOAcceptWithPrice(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the accepted price type of the market order for a
certain symbol.
Parameters
Key
Description
Symbol...
SYNTAX
Public Function SetMOLOCoverOffsetBuy(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the slippage amount of the covered market order
with Buy type for a certain symbol if the "Cover order as" opti...
SYNTAX
Public Function SetMOCoverAs(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the covering type of the market order for a
certain symbol.
Parameters
Key
Description
SymbolID
ID of th...
SYNTAX
Public Function SetMOCoverPercent(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the percentage amount of the covered market order
for a certain symbol.
Parameters
Key
Description
Sym...
SYNTAX
Public Function SetMOBetterPipsBuy(ByVal SymbolID As String, ByVal Value As Integer) As Transresult
DESCRIPTION
This function sets the better pips amount of the covered market order
with Buy type for a certain symbol when the "Price Condition" o...
SYNTAX
Public Function SetMOSymbolAlwaysCoverOnLiquidation(ByVal SymbolID As String, ByVal Value As Boolean) As TransResult
DESCRIPTION
This function sets the market order state if it is always covered on
liquidation for a certain symbol.
Parameters
...
SYNTAX
Public Function SetMOSymbolPriceCondition(ByVal SymbolID As String, ByVal Value As WhenToCover) As TransResult
DESCRIPTION
This function sets the market order price condition for a certain
symbol.
Parameters
Key
Description
SymbolID...
SYNTAX
Public Function SetMOSymbolWaitingSeconds(ByVal SymbolID As String, ByVal Value As Integer) As TransResult
DESCRIPTION
This function sets the waiting seconds when the market order will be
covered for a certain symbol.
Parameters
Key
Desc...
SYNTAX
Public Function GetLOAcceptAtOffsetBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the accepted limit order
with Buy type for a certain symbol.
Parameters
Key
Description
SymbolID
...
SYNTAX
Public Function GetLOAcceptWithPrice(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the accepted price type of the limit order for a
certain symbol.
Parameters
Key
Description
SymbolID
ID of the symbol
...
SYNTAX
Public Function GetLOLOCoverOffsetBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the covered limit order
with Buy type for a certain symbol if the "Cover order as" option is
set to "Limit order...
SYNTAX
Public Function GetLOCoverAs(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the covering type of the limit order for a
certain symbol.
Parameters
Key
Description
SymbolID
ID of the symbol
RETURN VALUE
...
SYNTAX
Public Function GetLOCoverPercent(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the percentage amount of the covered limit
order for a certain symbol.
Parameters
Key
Description
SymbolID
ID of the symbol
...
SYNTAX
Public Function GetLOBetterPipsBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the pips amount of the covered limit order with
Buy type for a certain symbol when the "Price Condition" option is set
to "Cover when LP pr...
SYNTAX
Public Function GetLOSymbolPriceCondition(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the price condition of the covered limit order
for a certain symbol.
Parameters
Key
Description
SymbolID
ID of the s...
SYNTAX
Public Function GetLOSymbolWaitingSeconds(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the waiting seconds for a certain symbol when
limit order will be covered.
Parameters
Key
Description
SymbolID
ID of...
SYNTAX
Public Function GetMOAcceptAtOffsetBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the accepted market order
for a certain symbol.
Parameters
Key
Description
SymbolID
ID of the sy...
SYNTAX
Public Function GetMOAcceptWithPrice(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the accepted price type of the market order for
a certain symbol.
PARAMETERS
Key
Description
SymbolID
ID of the symbol
...
SYNTAX
Public Function GetMOLOCoverOffsetBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the slippage amount of the covered market order
with Buy type for certain symbol if the "Cover order as" option is set
to "Limit order w...
SYNTAX
Public Function GetMOCoverAs(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the covering type of the market order for a
certain symbol.
PARAMETERS
Key
Description
SymbolID
ID of the symbol
RETURN VALUE...
SYNTAX
Public Function GetMOCoverPercent(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the percentage amount of the covered market
order for a certain symbol.
Parameters
Key
Description
SymbolID
ID of the symbol...
SYNTAX
Public Function GetMOBetterPipsBuy(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the better pips amount of the covered market
order with buy type for a certain symbol when the "Price Condition"
option is set to "Cover w...
SYNTAX
Public Function GetMOSymbolAlwaysCoverOnLiquidation(ByVal SymbolID As String) As TransResult
DESCRIPTION
This function returns the market order state if it is always covered
on liquidation for a certain symbol.
Parameters
Key
Description...
SYNTAX
Public Function GetMOSymbolPriceCondition(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the market order price condition for certain
symbol.
Parameters
Key
Description
SymbolID
ID of the symbol
RETURN...
SYNTAX
Public Function GetMOSymbolWaitingSeconds(ByVal SymbolID As String) As Integer
DESCRIPTION
This function returns the waiting seconds when the market order will
be covered for certain symbol.
Parameters
Key
Description
SymbolID
ID...
SYNTAX
Public Function GetBO() As VertexFXBO
DESCRIPTION
This function is used to return the Backoffice object.
RETURN VALUE
Returns a object of type VertexFXBO
[http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/3837].
SAM...
SYNTAX
Public Function SymbolsCount() As Long
DESCRIPTION
This function returns the symbols count.
Return value
Returns a number of type Long.
SAMPLE
Public Sub main()
Msgbox (BO.SymbolsCount())
End Sub
-------------------------
SEE ALSO
...
SYNTAX
Public Sub SwitchChat(ByVal State As Boolean)
DESCRIPTION
This sub enables or disables the chat screen of the Backoffice.
Parameters
Key
Description
State
The status of the chatting screen
Sample
Public Sub BOChatStatus (ByVal...
SYNTAX
Public Sub Disconnect()
DESCRIPTION
This sub disconnects the Backoffice.
Sample
Public Sub BOConnectionState (ByVal IsConnected As Boolean)
If IsConnected Then
BO. Disconnect ()
End If
End Sub
-------------------------...
SYNTAX
Public Sub Connect()
DESCRIPTION
This sub connects the Backoffice.
SAMPLE
Public Sub BOConnectionState (ByVal IsConnected As Boolean)
If Not IsConnected Then
BO.Connect ()
End If
End Sub
-------------------------
SEE ...
SYNTAX
Public Function RejectOrder(ByVal BOOrderID As String) As VertexFXBridgeAPI.TransResult
DESCRIPTION
This function rejects a certain market order.
Parameters
Key
Description
BOOrderID
ID of the order
Return value
Returns an inte...
SYNTAX
Public Function AcceptOrder(ByVal BOOrderID As String, Optional ByVal AtPrice As Double =0) As TransResult
DESCRIPTION
This function accepts a certain market order.
Parameters
Key
Description
BOOrderID
ID of the order
AtPrice...
Help Desk Software by Hybrid Solutions