Difference between revisions of "Portfolio GetMaxPotentialLossPerContract"
Jump to navigation
Jump to search
m (Reverted edits by 176.8.90.7 (talk) to last revision by JoshM) |
m (→Notes) |
||
| Line 7: | Line 7: | ||
== Notes == | == Notes == | ||
| − | This function can only be used in signals intended to be used with the [[:Category:Portfolio_Backtesting|Portfolio Backtester]]. | + | * This function can only be used in signals intended to be used with the [[:Category:Portfolio_Backtesting|Portfolio Backtester]]. |
| − | + | * Use [[Portfolio SetMaxPotentialLossPerContract]] to set the maximum potential loss for the specified symbol, and [[Portfolio MaxOpenPositionPotentialLoss]] to get the current combined potential loss for all open positions in the portfolio. | |
| + | |||
== Example == | == Example == | ||
<syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | ||
Revision as of 14:54, 19 February 2012
Returns one of the following:
- A numerical value indicated in the % box multiplied by -1, if the Max Potential Loss option is selected in the Portfolio Settings dialog window under the Portfolio Settings tab, or:
- A numerical value indicated in the $ box, if the Absolute Max Potential Loss option is selected in the Format Settings dialog window under the Portfolio Settings tab.
Usage
Portfolio_GetMaxPotentialLossPerContract
Notes
- This function can only be used in signals intended to be used with the Portfolio Backtester.
- Use Portfolio SetMaxPotentialLossPerContract to set the maximum potential loss for the specified symbol, and Portfolio MaxOpenPositionPotentialLoss to get the current combined potential loss for all open positions in the portfolio.
Example
Portfolio_GetMaxPotentialLossPerContract
Will return -5 if the Max Potential Loss option is selected and % box value is 5 under the Portfolio Settings tab in the Format Settings dialog window.
Portfolio_GetMaxPotentialLossPerContract
Will return 0.001 if the Absolute Max Potential Loss option is selected and $ box value is 0.001 under the Portfolio Settings tab in the Format Settings dialog window.
