GetAppInfo

From MultiCharts
Revision as of 11:12, 7 February 2012 by JoshM (talk | contribs)
Jump to navigation Jump to search

Returns a numerical value, representing the specified attribute of the calling application.

Usage

GetAppInfo(Attribute)

Parameters

aiBarSpacing - returns a value indicating the bar spacing of a chart (i.e. the value found in the Format Window -> X-Time scale screen).
aiHighestDispValue - returns the highest price value that could be displayed on a chart.
aiLowestDispValue - returns the lowest price value that could be displayed on a chart.
aiLeftDispDateTime - returns the DateTime value of the leftmost bar displayed on a chart. The integer portion of the DateTime value specifies the number of days since January 1st, 1900, and the fractional portion of the DateTime value specifies the fraction of the day since midnight. See the category Date & Time Routines for the reserved words for working with DateTime values.
aiRightDispDateTime - returns the DateTime value of the rightmost bar displayed on a chart. The integer portion of the DateTime value specifies the number of days since January 1st, 1900, and the fractional portion of the DateTime value specifies the fraction of the day since midnight. See the category Date & Time Routines for the reserved words for working with DateTime values.
aiSpaceToRight - returns the right margin, in number of bars, of a chart.
aiOptimizing - returns a value of 1 if the calling application is currently performing an optimization, and a value of 0 in all other cases.
aiStrategyAuto - returns a value of 1 if the calling application is using Automated Trade Execution, and a value of 0 in all other cases.
aiStrategyAutoConf - returns a value of 1 if the calling application is using Automated Trade Execution with Order Confirmation turned off, and a 1 in all other cases.
aiIntrabarOrder - returns a value of 1 if the calling application is running the signal with intra-bar order generation turned on, and a value of 0 in all other cases.
aiAppId - returns an unique non-zero integer identifying the calling application.
aiRealTimeCalc - returns a value of 1 if the calling application is performing calculation based on real-time data or on PlayBack data. Will return a value of 0 in all other cases.

Examples

GetAppInfo(aiBarSpacing)

Will return a value indicating the bar spacing of a chart.

GetAppInfo(aiStrategyAutoConf)

Will return a value of 0 if the calling application is using Automated Trade Execution with order confirmation turned off; otherwise aiStrategyAutoConf will return a value of 1.

GetAppInfo(aiRealTimeCalc)

Will return a value of 1 if the calling application’s calculations are based on real-time or PlayBack data; otherwise, will return a value of 0.