|
Syntax
Public Function PendingOrdersReport(ClientID As Integer, FromDate As String, ToDate As String, AccountID As Integer, OrderType As Integer, Lots As Double, SymbolID As Integer, Price As Double,TransTag As String) As CallingResultsEnum
Description
This function is used to get pending orders report that shows all the current pending Limit/Stop orders and SL/TP orders in your whole system or for a certain account(s)/ office(s). After PendingOrdersReport executes the ReportDataReceived event fire.
Parameters
| Parameter |
Description |
| ClientID |
This report shows all the current pending Limit/Stop orders and SL/TP orders in your whole system or for all accounts under this client |
| FromDate |
Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means from beginning
|
| ToDate |
Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means till now |
| AccountID |
This report shows all the current pending Limit/Stop orders and SL/TP orders in your whole system or for this account. 0 mean for all account
|
| OrderType |
This report shows the current pending Limit/Stop orders and SL/TP orders of this type
0 means all
1 buy limit type
-1 sell limit type
2 buy stop type
-2 sell stop type |
| Lots |
This report shows the current pending Limit/Stop orders and SL/TP orders of this amount. 0 mean for all amounts |
| SymbolID |
This report shows the current pending Limit/Stop orders and SL/TP orders of this symbol . 0 means for all symbols |
| Price |
This report shows the current pending Limit/Stop orders and SL/TP orders price. 0 means for all prices |
| TransTag |
String value used to mark the requested report when the result came from server |
Return value
Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult.
Sample
Private Sub PeOrRe_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles PeOrRe.Click
‘BOAPI is a predefined variable as CVertexBOAPI10
Dim vSymbol As COSymbol
VSymbol = BOAPI.SymbolByName ("USD/CHF")
If (vSymbol IsNot Nothing) Then
Dim Result As CallingResultsEnum
Result= BOAPI. PendingOrdersReport (BOAPI.RootID, "", "", 0, 0, 0, vSymbol.ID, 0,"")
End if
End Sub
Results
The result of this report contains many details, the following table shows each column description:
| Data row Index |
Column Name |
Description |
| 1 |
Account |
Shows the account ID for each client who has pending orders under the group that you have chosen for generated report. |
| 2 |
Order |
The order ID for each pending order. |
| 3 |
Type |
The type of each pending order (Limit/Stop or SL/TP)
2 : means Limit/Stop order
3 means SL/TP order |
| 4 |
B/S |
Shows if the pending order is (buy, sell, buy limit, buy stop, sell limit or sell stop order)
1 : means Buy/ Buy Limit
-1 : means Sell/Sell Limit
2 : means Buy Stop
-2 : means Sell Stop |
| 5 |
Amount |
The amount of each pending order |
| 6 |
SymbolID |
The symbol name of each pending order |
| 7 |
Price |
The sent price of each limit/stop pending order |
| 8 |
SL |
The sent price of the stop loss for pending orders |
| 9 |
TP |
The sent price of the take profit for pending orders |
| 10 |
Date/Time |
The date and time when the pending order was placed |
| 11 |
Client ID |
The client ID for the account |
| 12 |
TransTag |
The same string which sent by the requested report. |
See Also
VertexFX Backoffice API Index
| 
(0 vote(s))