Difference between revisions of "GetAppInfo"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Returns a numerical value, representing the specified attribute of the calling application. ==== Usage ==== <syntaxhighlight>GetAppInfo(Attribute)</syntaxhighlight> ==== ...")
 
Line 1: Line 1:
 
Returns a numerical value, representing the specified attribute of the calling application.   
 
Returns a numerical value, representing the specified attribute of the calling application.   
  
−
==== Usage ====
+
== Usage ==
 
<syntaxhighlight>GetAppInfo(Attribute)</syntaxhighlight>  
 
<syntaxhighlight>GetAppInfo(Attribute)</syntaxhighlight>  
  
−
==== Parameters ====
+
== Parameters ==  
−
[[aiBarSpacing]] - specifies return of the number of spaces between the bars on a chart GetAppInfo will return a value, indicating the bar spacing of a chart.
 
  
−
[[aiHighestDispValue]] - specifies return of the highest price value that could be displayed in the current chart window GetAppInfo will return the highest price value that could be displayed on a chart.  
+
:'''aiBarSpacing''' - returns a value indicating the bar spacing of a chart (i.e. the value found in the ''Format Window'' -> ''X-Time scale screen'').  
  
−
[[aiLowestDispValue]] - specifies return of the lowest price value that could be displayed in the current chart window GetAppInfo will return the lowest price value that could be displayed on a chart.  
+
:'''aiHighestDispValue''' - returns the highest price value that could be displayed on a chart.  
  
−
[[aiLeftDispDateTime]] - specifies return of the date and time of the leftmost bar displayed in the current chart window GetAppInfo will return 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.  
+
:'''aiLowestDispValue''' - returns the lowest price value that could be displayed on a chart.
  
−
[[aiRightDispDateTime]] - specifies return of the date and time of the rightmost bar displayed in the current chart window GetAppInfo will return 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.  
+
:'''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 [[:Category:Date_and_Time_Routines|Date & Time Routines]] for the reserved words for working with DateTime values.
  
−
[[aiSpaceToRight]] - specifies return of the right margin, in bars, of the current chart window GetAppInfo will return the right margin, in bars, of a chart.  
+
:'''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 [[:Category:Date_and_Time_Routines|Date & Time Routines]] for the reserved words for working with DateTime values.
  
−
[[aiOptimizing]] - specifies return of a numerical value, indicating whether the calling application is currently performing an optimization GetAppInfo will return a value of 1 only if the calling application is currently performing an optimization, and a value of 0 in all other cases.  
+
:'''aiSpaceToRight''' - returns the right margin, in number of bars, of a chart.
  
−
[[aiStrategyAuto]] - specifies return of a numerical value, indicating whether the calling application is using Automated Trade Execution GetAppInfo will return a value of 1 only if the calling application is using Automated Trade Execution, and a value of 0 in all other cases.  
+
:'''aiOptimizing''' - returns a value of 1 if the calling application is currently performing an optimization, and a value of 0 in all other cases.  
  
−
[[aiStrategyAutoConf]] - specifies return of a numerical value, indicating whether the calling application is using Automated Trade Execution with order confirmation turned off GetAppInfo will return a value of 0 only if the calling application is using Automated Trade Execution with order confirmation turned off, and a value of 1 in all other cases.  
+
:'''aiStrategyAuto''' - returns a value of 1 if the calling application is using [[Understanding_Automated_Trade_Execution|Automated Trade Execution]], and a value of 0 in all other cases.  
  
−
[[aiIntrabarOrder]] - specifies return of a numerical value, indicating whether the calling application is running the signal with intra-bar order generation turned on GetAppInfo will return a value of 1 only if the calling application is running the signal with intra-bar order generation turned on, and a value of 0 in all other cases.  
+
:'''aiStrategyAutoConf''' - returns a value of 1 if the calling application is using [[Understanding_Automated_Trade_Execution|Automated Trade Execution]] '''with''' Order Confirmation turned off, and a 1 in all other cases.
  
−
[[aiAppId]] - specifies return of a numerical value, used to identify the calling application GetAppInfo will return a unique non-zero integer identifying the calling application.  
+
:'''aiIntrabarOrder''' - returns a value of 1 if the calling application is running the signal with [[IntraBarOrderGeneration|intra-bar order generation]] turned on, and a value of 0 in all other cases.
  
−
[[aiRealTimeCalc]] - specifies return of a numerical value, indicating whether the calling application’s calculations are based on real-time data GetAppInfo will return a value of 1 only if the calling application’s calculations are based on real-time data, and a value of 0 in all other cases.  
+
:'''aiAppId''' - returns an unique non-zero integer identifying the calling application.  
−
 
−
==== Example ====
 
−
<syntaxhighlight>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
+
:'''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.
−
Automated Trade Execution with order confirmation turned off; otherwise, will return a value of 1
 
  
−
GetAppInfo(aiRealTimeCalc) will return a value of 1 if the calling application’s calculations
+
== Examples ==
−
are based on real-time data; otherwise, will return a value of 0</syntaxhighlight>
+
<syntaxhighlight>GetAppInfo(aiBarSpacing)</syntaxhighlight>
 +
Will return a value indicating the bar spacing of a chart.
  
 +
<syntaxhighlight>GetAppInfo(aiStrategyAutoConf)</syntaxhighlight>
 +
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.
 +
 +
<syntaxhighlight>GetAppInfo(aiRealTimeCalc)</syntaxhighlight>
 +
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.
  
 
[[Category:Environment Information]]
 
[[Category:Environment Information]]

Revision as of 11:12, 7 February 2012

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.

Retrieved from "https://www.multicharts.com/trading-software/index.php?title=GetAppInfo&oldid=1773"