665
edits
Changes
no edit summary
Redefines the values for the indicated symbol. The values in the '''$¤''' box if the [[Portfolio Settings|Absolute Max Potential Loss]] option is selected or the values in the '''% ''' box if the [[Portfolio Settings|Max Potential Loss]] is selected. The newly set value is valid during the strategy calculation or until the '''Portfolio_SetMaxPotentialLossPerContract''' is requested again assigning a new value.
== Usage ==
<syntaxhighlight>Portfolio_SetMaxPotentialLossPerContract(NewValue);</syntaxhighlight>
:'''NewValue''' - a numerical value that can be:
::* An absolute value in the range [-100, -0.001]; defines percentage of the maximum potential loss per contract. (Max Potential Loss: %) .::* a value in the range [0.001, 1e+29]; defines the maximum potential loss per contract in dollars. (Absolute Max Potential Loss: $¤) .::* equal 0; in this case the value entered in the '''Format Settings''' dialog window under the [[Portfolio Settings]] tab is used.
'''Portfolio_SetMaxPotentialLossPerContract''' returns:
* True if the value is in one of the ranges indicated above. Redefining is considered to be successful. * False if the if the value is out of the ranges indicated above. Redefining is considered unsuccessful and the '''Max Potential Loss value''' is unchanged.
== Notes ==
* This function can only be used in signals intended to be used with the [[:CategoryPortfolio Trader. * The value is returned in the currency specified in Portfolio Trader:Portfolio_Backtesting|'''Portfolio Backtester]]Settings -> Base Currency.'''
== Examples ==
<syntaxhighlight>Portfolio_SetMaxPotentialLossPerContract(200);</syntaxhighlight>
Redefines the maximum potential loss per contract for $200¤200.
[[Category:Portfolio Strategy Position]]