Portfolio GetMaxPotentialLossPerContract

From MultiCharts
Jump to: navigation, search

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.