|
Syntax
Public Function NetOpenPositionsReport (ClientID As Integer, AccountType As Integer, SymbolID As Integer, PositionType As Integer, TransTag As String) As CallingResultsEnum
Description
This function used to get the net open positions report that show the net open position details for all the accounts under clients Id. After NetOpenPositionsReport executes the ReportDataReceived event fire.
Parameters
| Parameter |
Description |
| ClientID |
This report shows the net open position details for all the accounts under this client, value of type Integer. |
| AccountType |
The type of the accounts that will appear in the report, wither it is for the normal accounts or for the coverage accounts, as value of type Integer.
1 : means normal accounts
2: means coverage accounts |
| SymbolID |
This report shows the net open position details for this symbol, as value of type Integer.
0 means all symbols |
| PositionType |
This report shows the net open position details for this type, as value of type Integer.
0 means all
1 buy type
-1 sell type |
| 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 OpPoRe_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles OpPoRe.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. NetOpenPositionsReport (BOAPI.RootID, 1, 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 under the group that you have chosen for the generated report |
| 2 |
B/S |
The type of the net open position (Buy/ Sell)
1 : means Buy Type
-1 : means Sell Type |
| 3 |
Amount |
The amount of each net open position |
| 4 |
Symbol ID |
The symbol Id of each net opened position |
| 5 |
Avg Price |
The average open price of each net opened position |
| 6 |
ClientID |
The client ID for the account |
| 7 |
TransTag |
The same string which sent by the requested report. |
See Also
VertexFX Backoffice API Index
|
String value used to mark the requested report when the result came from server
|
|
String value used to mark the requested report when the result came from server
|
|
String value used to mark the requested report when the result came from server
|
| 
(0 vote(s))