Submits an order to open a position.

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

Syntax

C#
public Position OpenPosition(
	PositionSettings options
)
Visual Basic
Public Function OpenPosition ( 
	options As PositionSettings
) As Position
Visual C++
public:
Position^ OpenPosition(
	PositionSettings^ options
)
F#
member OpenPosition : 
        options : PositionSettings -> Position 

Parameters

options
Type: RightEdge.Common..::..PositionSettings
Position options specifying the parameters of the position to open

Return Value

Type: Position
A newly created Position object.

Remarks

If the OpenPosition call succeeded, the Error property of the returned position will be null. If the call failed, then this property will contain a description of the error.

Note that success does not mean that the order was filled by the broker, just that an order was successfully sent to the broker. When this method returns successfully, the PositionState of the returned position will be Pending. If and when the order is filled, the state will change to Open.

See Also