CQG API 4.0 - Revised
SelectBySide Method
See Also  Send Feedback
order_side

Order side that will be used as the selection criteria, represented as eOrderSide

CQGOrders Collection : SelectBySide Method

Glossary Item Box

Description

Returns a sub-collection of current orders collection, filtered by order side.

Syntax

Visual Basic
Public Function SelectBySide( _
   ByVal order_side As eOrderSide _
) As CQGOrders

Parameters

order_side
ValueDescription
osdBuySide properties return this value if CQGAPIConfig.UseOrderSide is set to True.

Depending on the owner, osdBuy value is returned in case of:

  • the object is a CQGTrade referring to a buy trade
  • the object is a CQGPosition referring to a long position.

  • the object is a CQGOrder referring to an order of buy type.
  • the object is a CQGFill referring to a fill of buy type.
osdSellSide properties return this value if CQGAPIConfig.UseOrderSide is set to True.

Depending on the owner, osdSell value is returned in case of:

  • the object is a CQGTrade referring to a sell trade
  • the object is a CQGPosition referring to a short position.

  • the object is a CQGOrder referring to an order of sell type.
  • the object is a CQGFill referring to a fill of sell type.
osdUndefinedSide properties return this value if CQGAPIConfig.UseOrderSide is set to False.

Order side that will be used as the selection criteria, represented as eOrderSide

Return Type

A CQGOrders collection consisting of orders with the same Side that are picked from the current orders collection.

Example

See the usage of CQGOrders methods in the PrepareModify method's example section.

See Also