Changes
Created page with "Calculates and returns maximum potential loss (not including margin, commision or slippage) if user entered the position with the number of Contracts and Price of entr..."
Calculates and returns maximum potential loss (not including margin, commision or slippage) if user entered the position with the number of [[Contracts]] and [[Price]] of entry.
==== Usage ====
<syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (Side <,Contracts <,Price>>);</syntaxhighlight>
Parameters inside the angled brackets are optional
==== Parameters ====
Side is a numerical expression specifying the entry type (e.g. 1 Long entry or -1 Short entry).
[[Contracts]] is an optional parameter specifying the number of contracts. If the Contracts parameter is not specified, then the number of contracts indicated in the [[Format Settings]] dialog window under the [[Properties]] tab is used by default.
[[Price]] is an optional parameter specifying the price value. If the Price parameter is not specified, then the Close price value of the current bar will be used by default. This parameter can be rounded down if entered a Short position or rounded up if entered a Long position.
==== Notes ====
This function can only be used in signals intended to be used with the Portfolio Backtester.
==== Example ====
<syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (0, 25, High) will return a value of 0, since the parameter Side=0
Portfolio_CalcMaxPotentialLossForEntry (1, 100, Close) will return the maximum potential loss (not including margin, commision or slippage) if user entered a Long position for 100 contracts at the Close price.
Portfolio_CalcMaxPotentialLossForEntry (-1, 5, Open) will return the maximum potential loss (not including margin, commision or slippage) if user entered a Short position for 5 contracts at Open price.
Portfolio_CalcMaxPotentialLossForEntry (1) will return the maximum potential loss (not including margin, commision or slippage) if the user entered a Long position for a number of contracts indicated in the Format Settings dialog window under the Properties tab at Close price.</syntaxhighlight>
[[Category:Portfolio Strategy Position]]
==== Usage ====
<syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (Side <,Contracts <,Price>>);</syntaxhighlight>
Parameters inside the angled brackets are optional
==== Parameters ====
Side is a numerical expression specifying the entry type (e.g. 1 Long entry or -1 Short entry).
[[Contracts]] is an optional parameter specifying the number of contracts. If the Contracts parameter is not specified, then the number of contracts indicated in the [[Format Settings]] dialog window under the [[Properties]] tab is used by default.
[[Price]] is an optional parameter specifying the price value. If the Price parameter is not specified, then the Close price value of the current bar will be used by default. This parameter can be rounded down if entered a Short position or rounded up if entered a Long position.
==== Notes ====
This function can only be used in signals intended to be used with the Portfolio Backtester.
==== Example ====
<syntaxhighlight>Portfolio_CalcMaxPotentialLossForEntry (0, 25, High) will return a value of 0, since the parameter Side=0
Portfolio_CalcMaxPotentialLossForEntry (1, 100, Close) will return the maximum potential loss (not including margin, commision or slippage) if user entered a Long position for 100 contracts at the Close price.
Portfolio_CalcMaxPotentialLossForEntry (-1, 5, Open) will return the maximum potential loss (not including margin, commision or slippage) if user entered a Short position for 5 contracts at Open price.
Portfolio_CalcMaxPotentialLossForEntry (1) will return the maximum potential loss (not including margin, commision or slippage) if the user entered a Long position for a number of contracts indicated in the Format Settings dialog window under the Properties tab at Close price.</syntaxhighlight>
[[Category:Portfolio Strategy Position]]