Description
Requests a group of instruments.
Syntax
| Visual Basic |
|---|
Public Sub RequestInstrumentsGroup( _ ByVal group_request As CQGInstrumentsGroupRequest, _ ByVal trace_group_changes As Boolean _ ) |
Parameters
- group_request
The requested instruments group object; represented as CQGInstrumentsGroupRequest.
Use CQGCEL.CreateInstrumentsGroupRequest Method to create request object.
- trace_group_changes
If the value is True:
- All changes in resolved groups (such as added or removed contracts) are reported via CQGCEL.InstrumentsGroupChanged Event.
- All instruments in group are subscribed to real-time changes which are reported via CQGCEL.InstrumentChanged Event.
Remarks
This request is asynchronous. The execution result is reported via CQGCEL.InstrumentsGroupResolved event.
The request result is represented by the CQGInstrumentsGroup object. It is possible to access all resolved instrument groups via CQGCEL.AllInstrumentsGroups Property.
It is a good practice to cancel the request as soon as it becomes unnecessary. Such an approach allows using memory resources more optimal.
Use RemoveInstrumentsGroup to cancel request and remove resolved CQGInstrumentsGroup.