AtmStrategyCancelEntryOrder()

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Strategy > ATM Strategy Methods >

AtmStrategyCancelEntryOrder()

 Previous page Return to chapter overview Next page

Definition

Cancels the specified entry order determined by the string "orderId" parameter.  

 

Notes:

1.This method is intended ONLY for orders submitted as Atm Entry Orders and assumes the OrderState is NOT terminal (i.e., Cancelled, Filled, Rejected, Unknown).

2.If the specified order does not exist, the method returns false and an error is logged.

 

 

Method Return Value

Returns true if the specified order was found; otherwise false.

 

Syntax

AtmStrategyCancelEntryOrder(string orderId)

 

Warning:  This method should ONLY be called once the strategy State has reached State.Realtime

 

 

Parameters

orderId

The unique identifier for the entry order

 

 

Examples

ns

protected override void OnBarUpdate()
{
  // ATM strategy methods only work during real-time
  if (State != State.Realtime)
    return;
 
  string[] entryOrder = GetAtmStrategyEntryOrderStatus("orderId");
 
  // checks if the entry order exists
  // and the order state is not already cancelled/filled/rejected
  if (entryOrder.Length > 0 && entryOrder[2] == "Working")
  {
    AtmStrategyCancelEntryOrder("orderId");
  }
}