CQG API 4.0 - Revised
RequestCustomStudy Method
See Also  Send Feedback
cqg_custom_study_request

Specifies custom study request, which contains all the parameters as properties.

Notes:

Values provided for properties that are not required are ignored.

If values are not provided for properties that are required, an exception will be thrown.

CQGCEL Interface : RequestCustomStudy Method

Glossary Item Box

Description

Starts an asynchronous request for custom study.

Syntax

Visual Basic
Public Function RequestCustomStudy( _
   ByVal cqg_custom_study_request As CQGCustomStudyRequest _
) As CQGCustomStudy

Parameters

cqg_custom_study_request

Specifies custom study request, which contains all the parameters as properties.

Notes:

Values provided for properties that are not required are ignored.

If values are not provided for properties that are required, an exception will be thrown.

Remarks

An exception will be thrown if asynchronous request could not be made.

Otherwise, returns CQGCustomStudy object which doesn't contain any curves yet and status is rsInProgress

Notes:

It is a good practice to cancel the request as soon as it becomes unnecessary. Such approach allows using memory resources more optimal.

Call RemoveCustomStudy for request cancelling.

See Also