Difference between revisions of "Portfolio GetMaxPotentialLossPerContract"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | Returns: | + | 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|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 == | |
<syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | ||
| − | + | == Notes == | |
| − | This function can only be used in signals intended to be used with the Portfolio Backtester. | + | This function can only be used in signals intended to be used with the [[:Category:Portfolio_Backtesting|Portfolio Backtester]]. |
| − | + | == Example == | |
| − | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract | + | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> |
| − | and % box value is 5 under the Portfolio Settings tab in the Format Settings dialog window. | + | 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | ||
| + | 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. | ||
[[Category:Portfolio Strategy Properties]] | [[Category:Portfolio Strategy Properties]] | ||
Revision as of 06:59, 9 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.
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.
