Description
Returns the account historical cash excess.
Historical here means that the most recent cash excess that can be obtained is yesterday's close.
Syntax
| Visual Basic |
|---|
Public Function CashExcess( _ Optional ByVal day_ As Long = 1 _ ) As Double |
Parameters
- day_
The desired day represented as Long:
day_ = 1 (Default): Means "yesterday close"
day_ > 1: Means "historical value for the specified day back": 2 (two days back) i.e. "the day-before-yesterday close" etc.
Return Type
Cash excess value represented as Double.
If the requested day_ parameter is 1, yesterday close cash excess will be returned.
If the requested day_ parameter is larger than 1, the "close cash excess" of the requested day will be returned.
If no data is available for the requested day an invalid value will be returned.
Remarks
If the account summary was requested through CQGCEL.QuerySummariesStatement, (which has its Date_ parameter specified) day_ will be ignored.
Note: In this release only one day back (i.e., "yesterday close") value is available.
Example
See the usage of CQGAccountSummary methods in the AccountChanged event's example section.