Difference between revisions of "Portfolio GetMaxPotentialLossPerContract"
Jump to navigation
Jump to search
m (→Notes) |
|||
| Line 1: | Line 1: | ||
Returns one of the following: | 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 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 | + | * A numerical value indicated in the '''Absolute Max Potential Loss''' option box in the '''Format Settings''' dialog window under the [[Portfolio Settings]] tab. |
| − | + | ||
== Usage == | == Usage == | ||
<syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | ||
== Notes == | == Notes == | ||
| − | * This function can only be used in signals intended to be used with the | + | * This function can only be used in signals intended to be used with the Portfolio Trader. |
| + | * The absolute max potential loss value is returned in the currency specified in Portfolio Trader: '''Portfolio Settings -> Base Currency.''' | ||
* 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. | * 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. | ||
| Line 15: | Line 16: | ||
<syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | <syntaxhighlight>Portfolio_GetMaxPotentialLossPerContract</syntaxhighlight> | ||
| − | Will return 0.001 if the Absolute Max Potential Loss option is selected and | + | 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]] | ||
Latest revision as of 12:47, 25 July 2014
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 Absolute Max Potential Loss option box 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 Trader.
- The absolute max potential loss value is returned in the currency specified in Portfolio Trader: Portfolio Settings -> Base Currency.
- 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.
