Cancels an order that is submitted.

Namespace: RightEdge.Common
Assembly: Common (in Common.dll) Version: 2010.1.0.0 (2010.1.0.0)

Syntax

C#
bool CancelOrder(
	string orderId
)
Visual Basic
Function CancelOrder ( 
	orderId As String
) As Boolean
Visual C++
bool CancelOrder(
	String^ orderId
)
F#
abstract CancelOrder : 
        orderId : string -> bool 

Parameters

orderId
Type: System..::..String
Unique Id of this order as given in the SubmitOrder function.

Return Value

Type: Boolean
True if the cancel request was successfully sent.

Remarks

A true return value does not mean that the order was cancelled. Listen on the OrderUpdatedDelegate to determine if the cancellation was successful.

Only orders with a submitted or pending status can be cancelled. Orders that are filled or rejected cannot be cancelled.

See Also