Notes About Output Arrays for Functions

In the descriptions below for the functions, Intermediate Study Calculation Functions are identified by Type: Intermediate Study Calculation Function in the description.

Intermediate Study Calculation Functions in most cases require one or more or arrays for output of the results. These can take one of two types.

These types can be: SCFloatArrayRef (a reference to a Sierra Chart array of Float values) or SCSubgraphRef (a reference to a sc.Subgraph[] which contains multiple SCFloatArray arrays).

Array Based Study Functions That Do Not Use the Index Parameter

The Advanced Custom Study Interface has versions of functions (function "overloads" as known in C++) that take input and output arrays as parameters, and do not require the Index parameter.

These functions are called Intermediate Study Calculation Functions whether they require the Index parameter or not.

For example, they may calculate a Moving Average from an input data array and place the results into an output data array.

The versions that do not require the Index parameter simplify the calling of these functions. If your study function uses Automatic Looping by setting sc.AutoLoop = 1; in the if(sc.SetDefaults) block, then you can use these functions.

The function versions that do not use the Index parameter will not function properly when you are using Manual Looping.

You will see an example below of a call to an Intermediate Study Calculation Function, that uses the Index parameter and another call to a second version of that same function that does not use the Index parameter.

If your study function is using Automatic Looping, then you can use a version of an Intermediate Study Calculation Function that takes the Index parameter or the one that does not.

Using the version that does not require the Index parameter simply makes writing your code simpler.

When an Index parameter is not specified, the calculation always begins at sc.Index and will refer to data at that index and prior indexes. For example, calculating a moving average with a Length of 10, will start the calculation at sc.Index and go back 9 prior index elements for a total of 10.

if(sc.SetDefaults)
{
    //...
    sc.AutoLoop = 1;
    //...
}

//Calculates a 20 period moving average of Last prices.
sc.SimpleMovAvg(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], sc.Index, 20);

//Calculates a 20 period moving average of Last prices. 
//Index parameter not used. Same as above, but a more simple function call.
sc.SimpleMovAvg(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 20);
            

Return Object of Array Based Study Functions

Intermediate Study Calculation Functions that take a SCFloatArrayRef or SCSubgraphRef parameter for output, will return a SCFloatArray object by reference. This return object is either the SCFloatArray parameter, or the sc.SCSubgraph[].Data array of the sc.SCSubgraph parameter.

SCSubgraphRef MidBand = sc.Subgraph[1];

// Copy the middle Bollinger band value to Subgraph 10 at the current index
sc.Subgraph[10][sc.index]= sc.BollingerBands(

sc.BaseDataIn[SC_LAST],
MidBand,
Length.GetInt(),
StandardDeviations.GetFloat(),

MAType.GetMovAvgType() )[sc.index];
            

Working with Intermediate Study Calculation Functions

The code example below demonstrates using Intermediate Study Calculation Functions.

//Below are example calls to ACSIL intermediate study calculation functions.

//In this example we are giving the study function a graphable sc.Subgraph[].Data array.
//Even though that this Subgraph result can be drawn on the chart, it does not need to be
//if it does not have a visible DrawStyle
sc.SimpleMovAvg(sc.BaseData[SC_LAST], sc.Subgraph[0].Data, 10);

//Get the value from the calculation above
float AverageAtIndex = sc.Subgraph[0].Data[sc.Index];

//In this example we are giving the study function a Subgraph internal extra
//array which is not capable of being graphed.
sc.SimpleMovAvg(sc.BaseData[SC_LAST], sc.Subgraph[0].Arrays[0], 10);

AverageAtIndex = sc.Subgraph[0].Arrays[0][sc.Index];
            

The actual source code for intermediate study calculations functions is located in the SCStudyFunctions.cpp file in the /ACS_Source folder in the folder Sierra Chart is installed to on your computer system.

Cumulative Calculations with Intermediate Study Functions

The Output array parameter of a intermediate study calculation function can be used as the Input array parameter for another intermediate study calculation function.

The scsf_AverageOfAverage function in the /ACS_Source/studies3.cpp file in the Sierra Chart installation folder is an example of a function that shows how to use 2 intermediate study calculation functions (sc.LinearRegressionIndicator, sc.ExponentialMovAvg) together.

It calculates the Exponential Moving Average of a Linear Regression Indicator by passing the Output array from the Linear Regression Indicator to the Input array parameter of Exponential Moving Average.

sc.AdaptiveMovAvg()

Type: Intermediate Study Calculation Function

SCFloatArrayRef AdaptiveMovAvg(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length, float FastSmoothConstant, float SlowSmoothConstant);

SCFloatArrayRef AdaptiveMovAvg(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length, float FastSmoothConstant, float SlowSmoothConstant); Auto-looping only.

The sc.AdaptiveMovAvg() function calculates the standard Adaptive Moving Average study.

sc.AdaptiveMovAvg(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 20, 2.0f, 30.0f);

float MAValue = sc.Subgraph[0][sc.Index];
            

sc.AddACSChartShortcutMenuItem()

Refer to the sc.AddACSChartShortcutMenuItem() page for information on this function, as it is part of the Advanced Custom Study Interaction With Menus, Control Bar Buttons, Pointer Events documentation.

sc.AddACSChartShortcutMenuSeparator()

Refer to the sc.AddACSChartShortcutMenuSeparator() section for information on this function, as it is part of the Advanced Custom Study Interaction With Menus, Control Bar Buttons, Pointer Events documentation.

sc.AddAlertLine()

Type: Function

AddAlertLine(SCString Message, int ShowAlertLog = 0);

AddAlertLine(char* Message, int ShowAlertLog = 0);

sc.AddAlertLine() is a function for adding an Alert Message to the Sierra Chart Alerts Log.

To open the Alerts Log, select Window >> Alert Manager >> Alert Log.

This function adds a type of Alert Message to the Alerts Log which allows the Go to Chart commands on the Alerts Log to be used.

The Message text can be any text that you want to display in the Alerts Log. Message can be either a SCString type or a plain C++ string ("This is an Example").

ShowAlertLog needs to be set to 1 to cause the Alerts Log to open, if it is not already, when a message is added. Otherwise, ShowAlertLog needs to be 0 or it can be optionally left out to not open the Alerts Log when a message is added.

Refer to the scsf_LogAndAlertExample() function in the /ACS_Source/studies.cpp file in the Sierra Chart installation folder for example code to work with this function.

To make an Alert Message that contains formatted variables, refer to the Working With Text Strings section.

// Add an alert line to the Alerts Log
sc.AddAlertLine("Condition is TRUE");

sc.AddAlertLine("Condition is TRUE. The Alerts Log will open if it is not already.",1);

SCString MyString= "This is my string.";

sc.AddAlertLine(MyString,1);
            

sc.AddAlertLineWithDateTime()

Type: Function

AddAlertLineWithDateTime(const char* Message, int ShowAlertLog, SCDateTime AlertDateTime);

The sc.AddAlertLineWithDateTime function is identical to sc.AddAlertLine except that it has an AlertDateTime parameter of type SCDateTime, which can be set to a Date-Time value which will be included in the Alerts Log message.

When using the Go to Chart commands on the Alerts Log, the chart will be scrolled to this particular Date-Time.

sc.AddAndManageSingleTextDrawingForStudy()

Type: Function

void AddAndManageSingleTextDrawingForStudy(SCStudyInterfaceRef &sc, bool DisplayInFillSpace, int HorizontalPosition, int VerticalPosition, SCSubgraphRef Subgraph, int TransparentLabelBackground, SCString& TextToDisplay, int DrawAboveMainPriceGraph, int BoldFont);

The sc.AddAndManageSingleTextDrawingForStudy function adds a text drawing to the chart based upon the given parameters and implements the low-level management of that drawing.

This drawing is a nonuser drawn type of drawing. It cannot be interacted with by the user on the chart.

Only a single text drawing can be added with this function per study instance. Multiple text drawings are not supported. To do multiple text drawings you need to use the Text Drawing Tool from ACSIL.

For an example to use this function, refer to the scsf_LargeTextDisplayForStudy study function in the /ACS_Source/studies3.cpp file in the Sierra Chart installation folder.

sc.AddAndManageSingleTextUserDrawnDrawingForStudy()

Type: Function

void AddAndManageSingleTextUserDrawnDrawingForStudy(SCStudyInterfaceRef &sc, int Unused, int HorizontalPosition, int VerticalPosition, SCSubgraphRef Subgraph, int TransparentLabelBackground, SCString& TextToDisplay, int DrawAboveMainPriceGraph, int LockDrawing, int UseBoldFont);

sc.AddDateToExclude()

Type: Function

int AddDateToExclude(const int ChartNumber, const SCDateTime& DateToExclude);

The sc.AddDateToExclude() function adds the specified date for the chart to the list of Dates to Exclude.

sc.AddElements()

Type: Function

int AddElements(int NumElements);

sc.AddElements() adds the number of elements specified with the NumElements parameter, to the sc.Subgraph[].Data[] arrays.

The arrays up to the last actually used sc.Subgraph[].Data array, will actually have elements added. Unused sc.Subgraph[].Data arrays will be left un-allocated until they are needed.

This function must only used when you have set sc.IsCustomChart to 1 (TRUE).

The function returns 0 if it fails to add the requested number of elements to all the arrays.

This function also adds elements to the sc.DateTimeOut[] , sc.Subgraph[].DataColor[], and sc.Subgraph[].Arrays[][] arrays if they are used.

sc.AddElements(5); // Add five elements to the arrays
            

sc.AddLineUntilFutureIntersection()

Type: Function

AddLineUntilFutureIntersection(int StartBarIndex , int LineIDForBar , float LineValue , COLORREF LineColor , unsigned short LineWidth , unsigned short LineStyle , int DrawValueLabel , int DrawNameLabel , const SCString& NameLabel);

The sc.AddLineUntilFutureIntersection() function draws a line from the chart bar specified by the StartBarIndex parameter which specifies its array index, and at the value specified by the LineValue parameter. The line extends until it is intersected by a future price bar. The other supported parameters are described below.

All lines added by this function are automatically deleted any time the study they were added by, is removed from the chart or any time sc.IsFullRecalculation is TRUE.

Therefore, there is no need to delete them by calling sc.DeleteLineUntilFutureIntersection. However, this function can be used in other cases.

The type of line drawn by the sc.AddLineUntilFutureIntersection() function is not related to Chart Drawing Tools or to the sc.UseTool function.

sc.AddLineUntilFutureIntersectionEx()

Type: Function

AddLineUntilFutureIntersectionEx(const n_ACSIL::s_LineUntilFutureIntersection LineUntilFutureIntersection);

The sc.AddLineUntilFutureIntersectionEx() function draws a line from the chart bar specified by the n_ACSIL::s_LineUntilFutureIntersection::StartBarIndex parameter which specifies its array index, and at the value specified by the n_ACSIL::s_LineUntilFutureIntersection::LineValue parameter.

The line extends until it is intersected by a future price bar. The other supported parameters are described below.

All lines added by this function are automatically deleted any time the study they were added by, is removed from the chart or any time sc.IsFullRecalculation is TRUE.

Therefore, there is no need to delete them by calling sc.DeleteLineUntilFutureIntersection. However, this function can be used in other cases.

The type of line drawn by the sc.AddLineUntilFutureIntersection() function is not related to Chart Drawing Tools or to the sc.UseTool function.

sc.AddMessageToLog()

Type: Function

AddMessageToLog( SCString& Message, int Showlog);

sc.AddMessageToLog() is used to add a message to the log. See the scsf_LogAndAlertExample() function in the studies.cpp file inside the ACS_Source folder inside of the Sierra Chart installation folder for example code on how to work with this function.

sc.AddMessageToLog("This line of text will be added to the Message Log, but the message log will not pop open.", 0);
sc.AddMessageToLog("This line of text will be added to the Message Log, and this call will show the Message Log.", 1);
            

If you want to make a message line that contains formatted variables to add to the Message Log, refer to the Working With Text Strings and Setting Names section.

sc.AddStudyToChart()

Type: Function

int AddStudyToChart(const n_ACSIL::s_AddStudy& AddStudy);

The sc.AddStudyToChart is used to add a new study to a chart. This function takes a reference to the n_ACSIL::s_AddStudy structure which is documented below which specifies all of the parameters.

The various inputs available with a study can be set with the sc.SetChartStudyInput* functions.

	// Do data processing
	int& r_MenuID = sc.GetPersistentInt(1);

	if (sc.LastCallToFunction)
	{
		// Remove menu items when study is removed
		sc.RemoveACSChartShortcutMenuItem(sc.ChartNumber, r_MenuID);

		return;
	}

	if (sc.UpdateStartIndex == 0 && r_MenuID <= 0)
	{
		r_MenuID = sc.AddACSChartShortcutMenuItem(sc.ChartNumber, "Add Study Example");
	}

	if (sc.MenuEventID == r_MenuID)
	{
		n_ACSIL::s_AddStudy AddStudy;
		AddStudy.ChartNumber = sc.ChartNumber;
		AddStudy.StudyID = 2;
		AddStudy.ShortName = "New Moving Average";

		sc.AddStudyToChart(AddStudy);
	}
            

sc.AdjustDateTimeToGMT()

Type: Function

AdjustDateTimeToGMT( const SCDateTime& DateTime);

The sc.AdjustDateTimeToGMT() function converts the given DateTime from the time zone Sierra Chart is set to, to the GMT time zone.

SCDateTime DateTimeInGMT;
sc.AdjustDateTimeToGMT(sc.BaseDateTimeIn[sc.Index]);
            

sc.ADX()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ADX (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int DXLength, int DXMovAvgLength);

SCFloatArrayRef ADX (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int DXLength, int DXMovAvgLength); Auto-looping only.

The sc.ADX() function calculates the Average Directional Index (ADX) study.

sc.ADX(sc.BaseDataIn, sc.Subgraph[0], 14, 14);

float ADXValue = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.ADXR()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ADXR (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int DXLength, int DXMovAvgLength, int ADXRInterval);

SCFloatArrayRef ADXR (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int DXLength, int DXMovAvgLength, int ADXRInterval); Auto-looping only.

The sc.ADXR() function calculates the Average Directional Movement Rating.

sc.ADXR(sc.BaseDataIn, sc.Subgraph[0], 14, 14, 14);

float ADXRValue = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.AllocateMemory()

Type: Function

void* AllocateMemory (int Size);

The sc.AllocateMemory function allocates memory for the number of bytes specified by the Size parameter. A pointer to the beginning of the memory block is returned or a null pointer is returned if the memory could not be allocated by the operating system.

It is necessary to release the memory with the sc.FreeMemory function when finished with the memory, or when sc.LastCallToFunction is true.

It is also necessary to release the memory when the DLL module containing the custom study is released. For more information, refer to Modifying Advanced Custom Study Code.

sc.AngleInDegreesToSlope()

Type: Function

double AngleInDegreesToSlope(double AngleInDegrees);

sc.ApplyStudyCollection()

Type: Function

int ApplyStudyCollection(int ChartNumber, const SCString& StudyCollectionName, const int ClearExistingStudiesFromChart);

The sc.ApplyStudyCollection function applies the specified Study Collection to the specified chart.

Returns 1 if there is no error. Returns 0 if ChartNumber is invalid. 1 will still be returned even if StudyCollectionName is not found.

sc.ArmsEMV()

Type: Intermediate Study Calculation Function

This study function calculates the Arms Ease of Movement study.

SCFloatArrayRef ArmsEMV(SCBaseDataRef BaseDataIn, SCFloatArrayRef FloatArrayOut, int VolumeDivisor, int Index);

SCFloatArrayRef ArmsEMV(SCBaseDataRef BaseDataIn, SCFloatArrayRef FloatArrayOut, int VolumeDivisor); Auto-looping only.

The sc.ArmsEMV() function calculates the Arms Ease of Movement Value.

sc.ArmsEMV(sc.BaseDataIn, sc.Subgraph[0], 10);

float ArmsEMV = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.ArnaudLegouxMovingAverage()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ArnaudLegouxMovingAverage(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length, float Sigma, float Offset);

SCFloatArrayRef ArnaudLegouxMovingAverage(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length, float Sigma, float Offset); Auto-looping only.

The sc.ArnaudLegouxMovingAverage() function calculates the Arnaud Legoux Moving Average study.

sc.ArnaudLegouxMovingAverage(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 9, 6.0f, 0.5f);

float ArnaudLegouxMovingAverage = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.AroonIndicator()

Type: Intermediate Study Calculation Function

SCFloatArrayRef AroonIndicator(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Index, int Length);

SCFloatArrayRef AroonIndicator(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Length); Auto-looping only.

The sc.AroonIndicator() function calculates the Aroon Indicator.

sc.AroonIndicator(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 10);
float AroonIndicatorUp = sc.Subgraph[0][sc.Index]; //Access the Aroon Indicator Up study value at the current index 
float AroonIndicatorDown = sc.Subgraph[0].Arrays[0][sc.Index]; //Access the Aroon Indicator Down study value at the current index
            

sc.ArrayValueAtNthOccurrence()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ArrayValueAtNthOccurrence(SCFloatArrayRef FloatArrayIn1, SCFloatArrayRef FloatArrayIn2, int Index, int NthOccurrence);

SCFloatArrayRef ArrayValueAtNthOccurrence(SCFloatArrayRef FloatArrayIn1, SCFloatArrayRef FloatArrayIn2, int NthOccurrence ); Auto-looping only.

The sc.ArrayValueAtNthOccurrence() function iterates the FloatArrayIn1 array for non-zero values starting at Index and going back. When the number of non-zero values found in FloatArrayIn1 equals the number specified by NthOccurrence, then the value of FloatArrayIn2 is returned at the Index where the NthOccurrence of non-zero values was found in FloatArrayIn1.

For an example, refer to the scsf_ArrayValueAtNthOccurrenceSample function in the /ACS_Source/studies6.cpp file.

SCSubgraphRef ValueAtOccurence = sc.Subgraph[1];
ValueAtOccurence[sc.Index] = sc.ArrayValueAtNthOccurrence(StochasticData.Arrays[1],
StochasticData, NumberOfOccurrences.GetInt());
            

sc.ATR()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ATR(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length, unsigned int MovingAverageType);

SCFloatArrayRef ATR(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length, unsigned int MovingAverageType); Auto-looping only.

SCFloatArrayRef ATR(SCBaseDataRef BaseDataIn, SCFloatArrayRef FloatArrayOut_1, SCFloatArrayRef FloatArrayOut_2, int Index, int Length, unsigned int MovingAverageType);

SCFloatArrayRef ATR(SCBaseDataRef BaseDataIn, SCFloatArrayRef FloatArrayOut_1, SCFloatArrayRef FloatArrayOut_2 , int Length, unsigned int MovingAverageType);

THe sc.ATR() function calculates the Average TRUE Range.

sc.ATR(sc.BaseDataIn, sc.Subgraph[0], 20, MOVAVGTYPE_SIMPLE);

float ATR = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.AwesomeOscillator()

Type: Intermediate Study Calculation Function

SCFloatArrayRef AwesomeOscillator(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Index, int Length1, int Length2);

SCFloatArrayRef AwesomeOscillator(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Length1, int Length2); Auto-looping only.

The sc.AwesomeOscillator() function calculates the Awesome Oscillator study.

SCSubgraphRef MovAvgDiff = sc.Subgraph[0];
sc.AwesomeOscillator(sc.BaseDataIn[InputData.GetInputDataIndex()], MovAvgDiff, MA1Length.GetInt(), MA2Length.GetInt());
            

sc.BarIndexToRelativeHorizontalCoordinate()

Type: Function

int BarIndexToRelativeHorizontalCoordinate(int BarIndex);

 
int X = sc.BarIndexToRelativeHorizontalCoordinate (sc.Index);
            

sc.BarIndexToXPixelCoordinate()

Type: Function

int BarIndexToXPixelCoordinate(int Index);

The sc.BarIndexToXPixelCoordinate function will calculate the corresponding X-axis pixel coordinate from the given chart bar Index .

The returned x-coordinate is in relation to the chart window itself.

 
int X = sc.BarIndexToXPixelCoordinate (sc.Index);
            

sc.BollingerBands()

Type: Intermediate Study Calculation Function

SCFloatArrayRef BollingerBands (SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Index, int Length, float Multiplier, int MovingAverageType);

SCFloatArrayRef BollingerBands (SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Length, float Multiplier, int MovingAverageType); Auto-looping only.

The sc.BollingerBands() function calculates the Bollinger or Standard Deviation bands.

sc.BollingerBands(sc.BaseData[SC_LAST], sc.Subgraph[0], 10, 1.8, MOVAVGTYPE_SIMPLE);

//Access the individual lines
float Average = sc.Subgraph[0][sc.Index]; //Access the study value at the current index

float UpperBand = sc.Subgraph[0].Arrays[0][sc.Index];

float LowerBand = sc.Subgraph[0].Arrays[1][sc.Index];

//Copy to Visible Subgraphs
sc.Subgraph[1][sc.Index] = UpperBand;
sc.Subgraph[2][sc.Index] = LowerBand;
            

sc.Butterworth2Pole()

Type: Intermediate Study Calculation Function

SCFloatArrayRef Butterworth2Pole(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef Butterworth2Pole(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.Butterworth2Pole() function calculates a smoothing of data and is frequently used in the studies written by John Ehlers.

sc.Butterworth2Pole(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 10);

float Butterworth2Pole = sc.Subgraph[0][sc.Index]; //Access the function value at the current index
            

sc.Butterworth3Pole()

Type: Intermediate Study Calculation Function

SCFloatArrayRef Butterworth3Pole(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef Butterworth3Pole(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.Butterworth3Pole() function calculates a smoothing of data and is frequently used in the studies written by John Ehlers.

sc.Butterworth3Pole(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 10);

float Butterworth3Pole = sc.Subgraph[0][sc.Index]; //Access the function value at the current index
            

sc.CalculateAngle()

Type: Function

void CalculateAngle(SCFloatArrayRef InputArray, SCFloatArrayRef OutputArray, int Length, float ValuePerPoint);

void CalculateAngle(SCFloatArrayRef InputArray, SCFloatArrayRef OutputArray, int Index, int Length, float ValuePerPoint);

sc.CalculateAngle() calculates the angle from the horizontal of a given line defined by the starting position of InputArray[Index - Length], the ending position of InputArray[Index] and the ValuePerPoint. The results are contained within OutputArray at each Index point.

sc.CalculateLogLogRegressionStatistics()

Type: Function

void CalculateLogLogRegressionStatistics (SCFloatArrayRef In, double& Slope, double& Y_Intercept, int Index, int Length);

void CalculateLogLogRegressionStatistics (SCFloatArrayRef In, double& Slope, double& Y_Intercept, int Length); Auto-looping only

sc.CalculateOHLCAverages()

Type: Function

int CalculateOHLCAverages(int Index);

int CalculateOHLCAverages(); Auto-looping only.

sc.CalculateOHLCAverages() calculates the averages from the sc.Subgraph[].Data[] arrays SC_OPEN (0), SC_HIGH (1), SC_LOW (2), SC_LAST (3), and fills in the sc.Subgraph[].Data[] arrays for subgraphs SC_OHLC (4), SC_HLC (5), and SC_HL (6) for the elements at Index. You will want to use this if your study acts as a Main Price Graph. This would be the case when you set sc.UsePriceGraphStyle and sc.DisplayAsMainPriceGraph to 1 (TRUE).

// Fill in the averages arrays
sc.CalculateOHLCAverages(sc.Index);
            

sc.CalculateRegressionStatistics()

Type: Function

void CalculateRegressionStatistics (SCFloatArrayRef In, double& Slope, double& Y_Intercept, int Index, int Length);

void CalculateRegressionStatistics (SCFloatArrayRef In, double& Slope, double& Y_Intercept, int Length); Auto-looping only.

sc.CalculateTimeSpanAcrossChartBars()

Type: Function

double CalculateTimeSpanAcrossChartBars(int FirstIndex, int LastIndex);

The sc.CalculateTimeSpanAcrossChartBars function calculates the time span across the chart bars specified by the bar index parameters FirstIndex and LastIndex. The time length of the bar specified by LastIndex is also included in the time span.

If FirstIndex and LastIndex are the same, then the time length of the single specified bar will be what is returned.

The time span of a chart bar is determined to be the difference between the next bar's time and the bar's starting time. For the last bar in the chart, the time span is the difference between the last Date-Time contained within the chart bar and the bar's starting time.

However, the Session Times can affect the calculation of the time span for a bar. The very last bar just before the Session Times >> End Time will cause the time span to be limited to this ending time. The Session Times >> Start Time is not relevant or used in the calculations.

The return type is a double which is directly equivalent to a SCDateTime type and can be assigned to a SCDateTime type.

One useful purpose of this function is to determine if the particular span of time is sufficient enough for other calculations. This can be useful for detecting holidays.

sc.CalculateTimeSpanAcrossChartBarsInChart()

Type:: Function

void CalculateTimeSpanAcrossChartBarsInChart(int ChartNumber, int FirstIndex, int LastIndex, SCDateTime& TimeSpan);

The sc.CalculateTimeSpanAcrossChartBarsInChart function is nearly identical to the sc.CalculateTimeSpanAcrossChartBars function except that it allows a specific Chart to be referenced in the variable ChartNumber and returns the result in the referenced variable TimeSpan.

The sc.CalculateTimespanAcrossChartBarsInChart function calculates the time span across the chart bars specified by the bar index parameters FirstIndex and LastIndex. The time length of the bar specified by LastIndex is also included in the time span.

If FirstIndex and LastIndex are the same, then the time length of the single specified bar will be what is returned.

The time span of a chart bar is determined to be the difference between the next bar's time and the bar's starting time. For the last bar in the chart, the time span is the difference between the last Date-Time contained within the chart bar and the bar's starting time.

However, the Session Times can affect the calculation of the time span for a bar. The very last bar just before the Session Times >> End Time will cause the time span to be limited to this ending time. The Session Times >> Start Time is not relevant or used in the calculations.

The information is returned in the TimeSpan variable, which is an SCDateTime variable.

sc.CancelAllOrders()

Refer to the sc.CancelAllOrders() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.CancelOrder()

Refer to the sc.CancelOrder() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.CCI()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CCI(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Index, int Length, float Multiplier);

SCFloatArrayRef CCI(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Length, float Multiplier); Auto-looping only.

The sc.CCI() function calculates the Commodity Channel Index.

// Subgraph 0 will contain the CCI output
sc.CCI(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 20, 0.015);

float CCI = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.ChaikinMoneyFlow()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ChaikinMoneyFlow(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length);

SCFloatArrayRef ChaikinMoneyFlow(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length); Auto-looping only.

The sc.ChaikinMoneyFlow() function calculates the Chaikin Money Flow.

sc.ChaikinMoneyFlow(sc.BaseDataIn, sc.Subgraph[0], 10);

float ChaikinMoneyFlow = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.ChangeACSChartShortcutMenuItemText()

Refer to the sc.ChangeACSChartShortcutMenuItemText() page for information on this function, as it is part of the Advanced Custom Study Interaction With Menus, Control Bar Buttons, Pointer Events documentation.

sc.ChangeChartReplaySpeed()

Type: Function

int ChangeChartReplaySpeed(int ChartNumber, float ReplaySpeed);

The sc.ChangeChartReplaySpeed function changes the replay speed for the replaying chart specified by the ChartNumber parameter.

It is only possible to specify Chart Numbers that are within the same Chartbook which contains the chart which contains the study instance that this function is called from.

The chart replay speed is changed after the study function returns.

            int Result = sc.ChangeChartReplaySpeed(sc.ChartNumber, 10);
            

sc.ChartDrawingExists()

Refer to the sc.ChartDrawingExists() section on the Using Tools from an Advanced Custom Study page for information on this function.

sc.ChartIsDownloadingHistoricalData()

Type: Function

int ChartIsDownloadingHistoricalData(int ChartNumber);

The sc.ChartIsDownloadingHistoricalData() function returns TRUE (1) if the chart the study instance is on, is downloading historical chart data. This function returns FALSE(0) if historical chart data is not being downloaded even when the chart data is being read from the local data file.

This result can be useful when calling functions that play alert sounds. For example, if historical chart data is being downloaded, then avoid calling the sc.PlaySound() function because many alerts may be generated by your study function from historical data being downloaded.

It is normal that when a chart is first initially opened and historical chart data is not immediately downloaded, for this function to initially return FALSE when the study is initially calculated. Thereafter, the historical data will be downloaded if necessary.

This function should not be called frequently. Normally it is recommended to use it with manual looping and only call it at most once per study function call. Or in the case of automatic looping, it should be called only in relation to the most recent chart bar or once during a full recalculation.

int IsDownloading = sc.ChartIsDownloadingHistoricalData(sc.ChartNumber);
SCString MessageText;
MessageText.Format("Downloading state: %d", IsDownloading);

sc.AddMessageToLog(MessageText.GetChars(), 0);

//Only play alert sound and add message if chart is not downloading historical data
if (IsDownloading == 0)
    sc.PlaySound(1,"My Alert Message");
    
            

sc.ClearAlertSoundQueue()

Type: Function

void ClearAlertSoundQueue();

sc.ClearAllPersistentData()

Type: Function

void ClearAllPersistentData();

The sc.ClearAllPersistentData function clears all persistent data variables which have been set through the sc.GetPersistent*() or sc.SetPersistent*()functions.

The persistent data is held in STL maps and these maps are fully cleared.

sc.ClearCurrentTradedBidAskVolume()

Type: Function

uint32_t ClearCurrentTradedBidAskVolume();

The sc.ClearCurrentTradedBidAskVolume function clears the current traded Bid and Ask volume for the symbol of the chart.

For further information, refer to Current Traded Bid Volume.

sc.ClearCurrentTradedBidAskVolumeAllSymbols()

Type: Function

uint32_t ClearCurrentTradedBidAskVolumeAllSymbols();

The sc.ClearCurrentTradedBidAskVolumeAllSymbols function .

sc.ClearRecentBidAskVolume()

Type: Function

uint32_t ClearRecentBidAskVolume();

The sc.ClearRecentBidAskVolume function .

sc.ClearRecentBidAskVolumeAllSymbols()

Type: Function

uint32_t ClearRecentBidAskVolumeAllSymbols();

The sc.ClearRecentBidAskVolumeAllSymbols function .

sc.CloseChart()

Type: Function

void CloseChart(int ChartNumber);

The sc.CloseChart() function closes the chart specified by the ChartNumber parameter. The chart must exist within the same Chartbook that the custom study is also contained in.

For an example, refer to the scsf_CloseChart function in the /ACS_Source/studies5.cpp file in the Sierra Chart installation folder.

sc.CloseChartbook()

Type: Function

void CloseChartbook(const SCString& ChartbookFileName);

The sc.CloseChartbook() function closes the Chartbook specified by the ChartbookFileName filename parameter. The filename should not contain the path, only the filename.

For an example, refer to the scsf_CloseChartbook function in the /ACS_Source/studies5.cpp file in the Sierra Chart installation folder.

sc.CloseFile()

Type: Function

int CloseFile(const int FileHandle);

The sc.CloseFile() function closes the file with the File Handle, FileHandle, for the file which was opened with sc.OpenFile().

The function returns False if there is an error closing the file, otherwise it returns True.

Also refer to sc.OpenFile, sc.CloseFile, sc.ReadFile, sc.WriteFile, sc.GetLastFileErrorCode.

sc.CombinedForegroundBackgroundColorRef()

Type: Function

unsigned int CombinedForegroundBackgroundColorRef(COLORREF ForegroundColor, COLORREF BackgroundColor);

The sc.CombinedForegroundBackgroundColorRef function combines foreground and background color values into a single 32-bit value. This function is meant to be used to set the foreground and background colors through the sc.Subgraph[].DataColor[] array when displaying a table of values on a chart.

Since two 24-bit color values are combined into a 32 bit value, it reduces the color detail and the exact colors are not necessarily going to be represented.

Refer to the code example below.

sc.Subgraph[0].DataColor[sc.Index] = sc.CombinedForegroundBackgroundColorRef(COLOR_BLACK, COLOR_GREEN);
        

sc.ConvertCurrencyValueToCommonCurrency()

Type: Function

double ConvertCurrencyValueToCommonCurrency(double CurrencyValue, const SCString& SourceSymbol, SCString &OutputCurrency);

The sc.ConvertCurrencyValueToCommonCurrency function takes the parameters of CurrencyValue and SourceSymbol, determines the underlying currency for the given SourceSymbol based upon the Currency field of the Symbol Settings for that symbol and then returns the equivalent value in the Common Profit/Loss Currency setting.

Typically the SourceSymbol would be set to sc.Symbol.

The Common Profit/Loss Currency setting must be set to a value other than None for this function to convert the price.

The Common Profit/Loss Currency symbol is also returned in the reference SCString variable OutputCurrency.

For additional information, refer to Common Profit/Loss Currency.

sc.ConvertDateTimeFromChartTimeZone()

Type: Function

SCDateTime ConvertDateTimeFromChartTimeZone(const SCDateTime& DateTime, const char* TimeZonePOSIXString);

SCDateTime ConvertDateTimeFromChartTimeZone(const SCDateTime& DateTime, TimeZonesEnum TimeZone);

The sc.ConvertDateTimeFromChartTimeZone() function converts the DateTime parameter which is a SCDateTime variable which should be in the time zone of the chart the study instance is applied to, to the time zone specified by the TimeZone parameter.

The destination time zone can also be specified as a POSIX text string specified by the TimeZonePOSIXString parameter. For a list of these strings refer to the TIME_ZONE_POSIX_STRINGS array in the /ACS_Source/SCConstants.h file in the folder where Sierra Chart is installed to.

List of TimeZone constants that can be used:

• TIMEZONE_HONOLULU
• TIMEZONE_ANCHORAGE
• TIMEZONE_LOS_ANGELES
• TIMEZONE_PHOENIX_ARIZONA
• TIMEZONE_DENVER
• TIMEZONE_CHICAGO
• TIMEZONE_NEW_YORK
• TIMEZONE_HALIFAX
• TIMEZONE_UTC
• TIMEZONE_LONDON
• TIMEZONE_BRUSSELS
• TIMEZONE_CAPE_TOWN
• TIMEZONE_ATHENS
• TIMEZONE_BAGHDAD
• TIMEZONE_MOSCOW
• TIMEZONE_DUBAI
• TIMEZONE_ISLAMABAD
• TIMEZONE_NEW_DELHI
• TIMEZONE_DHAKA
• TIMEZONE_JAKARTA
• TIMEZONE_HONG_KONG
• TIMEZONE_TOKYO
• TIMEZONE_BRISBANE
• TIMEZONE_SYDNEY
• TIMEZONE_UTC_PLUS_12
• TIMEZONE_AUCKLAND

sc.ConvertDateTimeToChartTimeZone()

Type: Function

SCDateTime ConvertDateTimeToChartTimeZone(const SCDateTime& DateTime, const char* TimeZonePOSIXString);

SCDateTime ConvertDateTimeToChartTimeZone(const SCDateTime& DateTime, TimeZonesEnum TimeZone);

The sc.ConvertDateTimeToChartTimeZone() function converts the DateTime SCDateTime variable from the specified TimeZone to the Time Zone used by the chart the study instance is applied to. This can either be the global Time Zone or a chart specific Time Zone. For additional information, refer to Time Zone.

The source time zone can also be specified as a POSIX text string. For a list of these strings refer to the TIME_ZONE_POSIX_STRINGS array in the /ACS_Source/SCConstants.h file in the folder where Sierra Chart is installed to.

List of TimeZone constants that can be used:

• TIMEZONE_HONOLULU
• TIMEZONE_ANCHORAGE
• TIMEZONE_LOS_ANGELES
• TIMEZONE_PHOENIX_ARIZONA
• TIMEZONE_DENVER
• TIMEZONE_CHICAGO
• TIMEZONE_NEW_YORK
• TIMEZONE_HALIFAX
• TIMEZONE_UTC
• TIMEZONE_LONDON
• TIMEZONE_BRUSSELS
• TIMEZONE_CAPE_TOWN
• TIMEZONE_ATHENS
• TIMEZONE_BAGHDAD
• TIMEZONE_MOSCOW
• TIMEZONE_DUBAI
• TIMEZONE_ISLAMABAD
• TIMEZONE_NEW_DELHI
• TIMEZONE_DHAKA
• TIMEZONE_JAKARTA
• TIMEZONE_HONG_KONG
• TIMEZONE_TOKYO
• TIMEZONE_BRISBANE
• TIMEZONE_SYDNEY
• TIMEZONE_UTC_PLUS_12
• TIMEZONE_AUCKLAND

// Convert the DateTime from New York time to the time zone used for charts
DateTime = sc.ConvertDateTimeToChartTimeZone(DateTime, TIMEZONE_NEW_YORK);
DateTime.GetDateTimeYMDHMS(Year, Month, Day, Hour, Minute, Second);

// Write to the message log
SCString MessageString.Format("Converted from New York time: %d-%02d-%02d %02d:%02d:%02d", Year, Month, Day, Hour, Minute, Second);
sc.AddMessageToLog(MessageString, 1);
            

sc.CreateDoublePrecisionPrice()

Type: Function

double CreateDoublePrecisionPrice(const float PriceValue);

sc.CreateProfitLossDisplayString()

Type: Function

void CreateProfitLossDisplayString(double ProfitLoss, int Quantity, PositionProfitLossDisplayEnum ProfitLossFormat, SCString& Result);

The sc.CreateProfitLossDisplayString() function creates a Profit/Loss text string based on the provided parameters.

The Result parameter is passed by reference and receives the formatted Profit/Loss text string.

if (ShowOpenPL.GetYesNo())
{
    SCString PLString;
    double Commission = RTCommissionRate * PositionData.PositionQuantity / 2.0;
    sc.CreateProfitLossDisplayString(PositionData.OpenProfitLoss-Commission, PositionData.PositionQuantity, ProfitLossDisplayFormat, PLString);
    Text.Format("Open PL: %s", PLString.GetChars());
}
            

sc.CrossOver()

Type: Function

int CrossOver (SCFloatArrayRef First, SCFloatArrayRef Second, int Index);

int CrossOver (SCFloatArrayRef First, SCFloatArrayRef Second); Auto-looping only.

sc.CrossOver returns a value indicating if the First study Subgraph has crossed the Second subgraph at the array index specified by Index.

For an example, refer to the scsf_StochasticCrossover function in the /ACS_Source/Systems.cpp file in the Sierra Chart installation folder.

Function return values:

• CROSS_FROM_TOP - This constant value is returned when the First subgraph crosses the Second subgraph from the top.
• CROSS_FROM_BOTTOM - This constant value is returned when the First subgraph crosses the Second subgraph from the bottom.
• NO_CROSS - This constant value is returned when the First subgraph does not cross the Second subgraph.

if (sc.CrossOver(sc.Subgraph[3], sc.Subgraph[4]) == CROSS_FROM_BOTTOM)
{

    //Code
}

// This is an example of looking for a crossover between the values in
// a subgraph and a fixed value. We first have to put the fixed value
// into an array. We are using one of the Subgraph internal arrays.
sc.Subgraph[2].Arrays[8][sc.Index] = 100.0;

if (sc.CrossOver(sc.Subgraph[2], sc.Subgraph[2].Arrays[8]) == CROSS_FROM_BOTTOM)
{

    //Code
}
            

	
//Check for crossover of Subgraph 0 and a fixed value set into an extra array on the Subgraph
SCFloatArrayRef FixedValueArray = sc.Subgraph[0].Arrays[4];
FixedValueArray[sc.Index] = 100;

//Check if a crossover occurred
if(sc.CrossOver(sc.Subgraph[0], FixedValueArray) != NO_CROSS)
{

}
            

sc.CumulativeDeltaTicks()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CumulativeDeltaTicks(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int ResetCumulativeCalculation);

SCFloatArrayRef CumulativeDeltaTicks(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int ResetCumulativeCalculation); Auto-looping only.

The sc.CumulativeDeltaTicks function calculates the Cumulative Delta Ticks study and provides the Open, High, Low and Last values for each bar. This function can only be used on Intraday charts.

For an example of how to use a function of this type, refer to the scsf_CumulativeDeltaBarsTicks function in the /ACS_Source/studies8.cpp file in the Sierra Chart installation folder.

sc.CumulativeDeltaTickVolume()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CumulativeDeltaTickVolume(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int ResetCumulativeCalculation);

SCFloatArrayRef CumulativeDeltaTickVolume(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int ResetCumulativeCalculation); Auto-looping only.

The sc.CumulativeDeltaTickVolume function calculates the Cumulative Delta Up/Down Tick Volume study and provides the Open, High, Low and Last values for each bar. This function can only be used on Intraday charts.

For an example of how to use a function of this type, refer to the scsf_CumulativeDeltaBarsTicks function in the /ACS_Source/studies8.cpp file in the Sierra Chart installation folder.

sc.CumulativeDeltaVolume()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CumulativeDeltaVolume(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int ResetCumulativeCalculation);

SCFloatArrayRef CumulativeDeltaVolume(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int ResetCumulativeCalculation); Auto-looping only.

The sc.CumulativeDeltaVolume function calculates the Cumulative Delta Volume study and provides the Open, High, Low and Last values for each bar. This function can only be used on Intraday charts.

For an example of how to use a function of this type, refer to the scsf_CumulativeDeltaBarsTicks function in the /ACS_Source/studies8.cpp file in the Sierra Chart installation folder.

sc.CumulativeSummation()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CumulativeSummation (SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index);

SCFloatArrayRef CumulativeSummation (SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut); Auto-looping only.

The sc.CumulativeSummation function calculates the summation of all of the elements in FloatArrayIn up to the current Index. Therefore, this function is cumulative in that the summation is across all of the elements in FloatArrayIn from the beginning.

sc.CumulativeSummation(sc.BaseDataIn[SC_HIGH], sc.Subgraph[0]);

float CumulativeSummation = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.CyberCycle()

Type: Intermediate Study Calculation Function

SCFloatArrayRef CyberCycle(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArraySmoothed, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef CyberCycle(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArraySmoothed, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.CyberCycle() function calculates Ehlers' Cyber Cycle study.

sc.CyberCycle(sc.BaseDataIn[SC_LAST], Array_SmoothedData, sc.Subgraph[0], 28);

float CyberCycle = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.DataTradeServiceName()

Type: Function

SCString DataTradeServiceName();

The sc.DataTradeServiceName() function returns the text name of the Service currently set in Global Settings >> Data/trade Service Settings. The return type is a SCString.

sc.DatesToExcludeClear()

Type: Function

int sc.DatesToExcludeClear(const int ChartNumber);

The sc.DatesToExcludeClear() function removes all dates from the Dates to Exclude for a chart.

sc.DateStringDDMMYYYYToSCDateTime()

Type: Function

double sc.DateStringDDMMYYYYToSCDateTime(const SCString& DateString);

The sc.DateStringDDMMYYYYToSCDateTime() function converts the DateString text string parameter to an SCDateTime.

DateString is a SCString type.

The return type is a double data type directly compatible with a SCDateTime and can be assigned to a SCDateTime.

SCDateTime Date = sc.DateStringDDMMYYYYToSCDateTime("05012017");
            

sc.DateStringToSCDateTime()

Type: Function

SCDateTime DateStringToSCDateTime(const SCString& DateString);

The sc.DateStringToSCDateTime() function converts the DateString text string to an SCDateTime variable. This function only works with dates.

SCString DateString ("2011-12-1");
SCDateTime DateValue;
DateValue = sc.DateStringToSCDateTime(DateString);
            

sc.DateTimeToString()

Type: Function

SCString DateTimeToString(const double& DateTime, int Flags);

The sc.DateTimeToString function will convert the given DateTime variable to a text string. The format is specified by the Flags parameter.

The flags can be any of the following:

• FLAG_DT_YEAR
• FLAG_DT_MONTH
• FLAG_DT_DAY
• FLAG_DT_HOUR
• FLAG_DT_MINUTE
• FLAG_DT_SECOND
• FLAG_DT_PLUS_WITH_TIME
• FLAG_DT_NO_ZERO_PADDING_FOR_DATE
• FLAG_DT_HIDE_SECONDS_IF_ZERO
• FLAG_DT_NO_HOUR_PADDING
• FLAG_DT_MILLISECOND
• FLAG_DT_COMPACT_DATE
• FLAG_DT_COMPLETE_DATE
• FLAG_DT_COMPLETE_TIME
• FLAG_DT_COMPLETE_DATETIME
• FLAG_DT_COMPLETE_DATETIME_MS

 
if(sc.Index == sc.ArraySize - 1)
{
    // Log the current time
    SCString DateTimeString = sc.DateTimeToString(sc.CurrentSystemDateTime,FLAG_DT_COMPLETE_DATETIME_MS);

    sc.AddMessageToLog(DateTimeString, 0);
}
            

sc.DateToString()

Type: Function

SCString DateToString(const SCDateTime& DateTime);

The sc.DateToString function returns a text string for the date within the given DateTime parameter. Any time component in the given DateTime parameter will be ignored.

 
if (sc.Index == sc.ArraySize - 1)
{
    // Log the current date.
    SCString DateString = sc.DateToString(sc.CurrentSystemDateTime);

    sc.AddMessageToLog(DateString, 0);
}
            

sc.DeleteACSChartDrawing()

Refer to the sc.DeleteACSChartDrawing() section on the Using Tools from an Advanced Custom Study page for information on this function.

sc.DeleteLineUntilFutureIntersection()

Type: Function

int DeleteLineUntilFutureIntersection(int StartBarIndex, int LineIDForBar);

The sc.DeleteLineUntilFutureIntersection function deletes a line added by the sc.AddLineUntilFutureIntersection function.

sc.DeleteUserDrawnACSDrawing()

Refer to the sc.DeleteUserDrawnACSDrawing() section on the Using Tools from an Advanced Custom Study page for information on this function.

sc.Demarker()

Type: Intermediate Study Calculation Function

SCFloatArrayRef Demarker(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length);

SCFloatArrayRef Demarker(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length); Auto-looping only.

The sc.Demarker() function calculates the Demarker study.

sc.Demarker(sc.BaseDataIn, sc.Subgraph[0], 10);
float Demarker = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.Dispersion()

Type: Intermediate Study Calculation Function

SCFloatArrayRef Dispersion(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef Dispersion(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.Dispersion() function calculates the Dispersion study.

sc.Dispersion(sc.BaseDataIn[SC_HIGH], sc.Subgraph[0], 10);

float Dispersion = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.DMI()

Type: Intermediate Study Calculation Function

DMI(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length);

DMI(SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length); Auto-looping only.

The sc.DMI() function calculates the Directional Movement Index study.

sc.DMI(sc.BaseDataIn, sc.Subgraph[0], 10);

//Access the individual study values
float DMIPositive = sc.Subgraph[0][sc.Index];

float DMINegative = sc.Subgraph[0].Arrays[0][sc.Index];

//Copy DMINegative to a visible Subgraph
sc.Subgraph[1][sc.Index] = DMINegative;
            

sc.DMIDiff()

Type: Intermediate Study Calculation Function

SCFloatArrayRef DMIDiff (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length);

SCFloatArrayRef DMIDiff (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length); Auto-looping only.

The sc.DMIDiff() function calculates the Directional Movement Index Difference study.

sc.DMIDiff(sc.BaseDataIn, sc.Subgraph[0], 10);

float DMIDiff = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.DominantCyclePeriod()

Type: Intermediate Study Calculation Function.

SCFloatArrayRef sc.DominantCyclePeriod (SCFloatArrayRef In, SCSubgraphRef Out, int IndexParam, int MedianLength);

The sc.DominantCyclePeriod() function calculates the Dominant Cycle Period and is frequently used in the studies written by John Ehlers.

sc.DominantCyclePeriod(sc.BaseData[SC_LAST], sc.Subgraph[0], 5);
            

sc.DominantCyclePhase()

Type: Intermediate Study Calculation Function.

SCFloatArrayRef sc.DominantCyclePhase (SCFloatArrayRef In, SCSubgraphRef Out, int Index);

The sc.DominantCyclePhase() function calculates the Dominant Cycle Phase and is frequently used in the studies written by John Ehlers.

sc.DominantCyclePhase(sc.BaseData[SC_LAST], sc.Subgraph[0]);
            

sc.DoubleStochastic()

Type: Intermediate Study Calculation Function

SCFloatArrayRef DoubleStochastic (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Length, int MovAvgLength, int MovingAverageType);

SCFloatArrayRef DoubleStochastic (SCBaseDataRef BaseDataIn, SCSubgraphRef SubgraphOut, int Index, int Length, int MovAvgLength, int MovingAverageType); Auto-looping only.

The sc.DoubleStochastic() function calculates the Double Stochastic study.

sc.DoubleStochastic(sc.BaseData, sc.Subgraph[0], Length.GetInt(), MovAvgLength.GetInt(), MovAvgType.GetMovAvgType());

//Access the study value at the current index
float DoubleStochastic = sc.Subgraph[0][sc.Index]; 
            

sc.EnvelopeFixed()

Type: Intermediate Study Calculation Function

SCFloatArrayRef EnvelopeFixed(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, float FixedValue, int Index);

SCFloatArrayRef EnvelopeFixed(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, float FixedValue); Auto-looping only.

The sc.EnvelopeFixed() function calculates the Fixed Envelope study.

sc.EnvelopeFixed(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 3.5);
//Access the individual study values at the current index
float EnvelopeTop = sc.Subgraph[0][sc.Index]; 
float EnvelopeBottom = sc.Subgraph[0].Arrays[0][sc.Index];
            

sc.EnvelopePct()

Type: Intermediate Study Calculation Function

SCFloatArrayRef EnvelopePct(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, float Percent, int Index);

SCFloatArrayRef EnvelopePct(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, float Percent); Auto-looping only.

The sc.EnvelopePct() function calculates the Percentage Envelope study.

sc.EnvelopePct(sc.BaseDataIn[SC_HIGH], sc.Subgraph[0], 0.05);

//Access the individual study values at the current index
float Top = sc.Subgraph[0][sc.Index];

float Bottom = sc.Subgraph[0].Arrays[0][sc.Index];

//Copy to Visible Subgraphs
sc.Subgraph[1][sc.Index] = Bottom;
            

sc.Ergodic()

Type: Intermediate Study Calculation Function

SCFloatArrayRef Ergodic(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int Index, int LongEMALength, int ShortEMALength, float Multiplier);

SCFloatArrayRef Ergodic(SCFloatArrayRef FloatArrayIn, SCSubgraphRef SubgraphOut, int LongEMALength, int ShortEMALength, float Multiplier); Auto-looping only.

The sc.Ergodic() function calculates the True Strength Index.

sc.Ergodic(
    sc.BaseDataIn[SC_LAST],
    sc.Subgraph[0],
    15, // Long EMA length
    3, // Short EMA length
    1.0f, // Multiplier
);

// You can calculate the signal line and oscillator with the following code:

// Calculate the signal line with an exponential moving average with a length of 10
sc.ExponentialMovAvg(sc.Subgraph[0], sc.Subgraph[1], 10);

// Calculate the oscillator
sc.Subgraph[2][sc.Index] = sc.Subgraph[0][sc.Index] - sc.Subgraph[1][sc.Index];
            

sc.EvaluateAlertConditionFormulaAsBoolean()

Type: Function

int EvaluateAlertConditionFormulaAsBoolean(int BarIndex, int ParseAndSetFormula);

The sc.EvaluateAlertConditionFormulaAsBoolean() function evaluates the Alert formula entered on the study that calls this function, and returns a 1 (true) or 0 (false) depending upon whether the formula is true or false at the specified BarIndex.

When the ParseAndSetFormula parameter is set to a nonzero value, then the Alert condition is internally formatted and stored prior to testing the condition at the BarIndex. It is necessary to set ParseAndSetFormula to a nonzero value the first time running this function or whenever the alert formula changes. It should not be set to a nonzero value every time because it is not efficient doing that.

sc.EvaluateGivenAlertConditionFormulaAsBoolean()

Type: Function

int EvaluateGivenAlertConditionFormulaAsBoolean(int BarIndex, int ParseAndSetFormula, const SCString& Formula);

The sc.EvaluateGivenAlertConditionFormulaAsBoolean() function evaluates the given Formula parameter, and returns a 1 (true) or 0 (false) depending upon whether the given Formula at the specified BarIndex is true or false.

When the ParseAndSetFormula parameter is set to a nonzero value, then the Formula is internally formatted and stored prior to testing the condition at the BarIndex. It is necessary to set ParseAndSetFormula to a nonzero value the first time running this function or whenever the Formula changes. It should not be set to a nonzero value every time because it is not efficient doing that.

sc.EvaluateGivenAlertConditionFormulaAsDouble()

Type: Function

double EvaluateGivenAlertConditionFormulaAsDouble(int BarIndex, int ParseAndSetFormula, const SCString& Formula);

The sc.EvaluateGivenAlertConditionFormulaAsDouble() function evaluates the given Formula parameter, and returns the calculated value for the formula at the specified BarIndex.

When the ParseAndSetFormula parameter is set to a nonzero value, then the Formula is internally formatted and stored prior to calculating the formula at the BarIndex. It is necessary to set ParseAndSetFormula to a nonzero value the first time running this function or whenever the Formula changes. It should not be set to a nonzero value every time because it is not efficient doing that.

sc.ExponentialMovAvg()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ExponentialMovAvg(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef ExponentialMovAvg(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.ExponentialMovAvg() function calculates the exponential moving average.

sc.ExponentialMovAvg(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 20);

float ExponentialMovAvg = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.ExponentialRegressionIndicator()

Type: Intermediate Study Calculation Function

SCFloatArrayRef ExponentialRegressionIndicator(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index, int Length);

SCFloatArrayRef ExponentialRegressionIndicator(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Length); Auto-looping only.

The sc.ExponentialRegressionIndicator() function calculates the Exponential Regression Indicator study.

sc.ExponentialRegressionIndicator(sc.BaseDataIn[SC_LAST], sc.Subgraph[0], 10);

float ExponentialRegressionIndicator = sc.Subgraph[0][sc.Index]; //Access the study value at the current index
            

sc.FillSubgraphElementsWithLinearValuesBetweenBeginEndValues

Type: Function

void FillSubgraphElementsWithLinearValuesBetweenBeginEndValues(int SubgraphIndex, int BeginIndex, int EndIndex);

The sc.FillSubgraphElementsWithLinearValuesBetweenBeginEndValues() function fills the study Subgraph array specified by the SubgraphIndex parameter from the element after BeginIndex to the element just before the EndIndex parameters, with the linear values in between the values specified by those index parameters. SubgraphIndex is 0 based, therefore 0 is the first Subgraph.

For example, if the value at BeginIndex is 2.0 and the index is 10, and the value at EndIndex is 2.4 and the index is 14, then at indices 11, 12, and 13 the set values will be 2.1, 2.2, and 2.3 respectively.

sc.FlattenAndCancelAllOrders()

Refer to the sc.FlattenAndCancelAllOrders() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.FlattenPosition()

Refer to the sc.FlattenPosition() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.FormatDateTime()

Type: Function

SCString FormatDateTime(const SCDateTime& DateTime);

The sc.FormatDateTime() function returns a formatted text string for the given DateTime parameter. The returned text string will contain both the date and the time.

SCString Message;

Message.Format("Current Bar Date-Time: %s", sc.FormatDateTime(sc.BaseDateTimeIn[sc.Index]).GetChars());

sc.AddMessageToLog(Message, 0);
            

sc.FormatDateTimeMS()

Type: Function

SCString FormatDateTimeMS(const SCDateTime& DateTimeMS);

The sc.FormatDateTimeMS() function returns a formatted text string for the given DateTimeMS parameter. The returned text string will contain both the date and the time, including milliseconds.

SCString Message;

Message.Format("Current System Date-Time: %s", sc.FormatDateTimeMS(sc.CurrentSystemDateTimeMS).GetChars());

sc.AddMessageToLog(Message, 0);
            

sc.FormatGraphValue()

Type: Function

SCString FormatGraphValue(double Value, int ValueFormat);

sc.FormatGraphValue() formats a numeric value as text based on the specified value format. The text is returned as an SCString.

SCString CurHigh = sc.FormatGraphValue(sc.BaseData[SC_HIGH][CurrentVisibleIndex], sc.BaseGraphValueFormat);

s_UseTool Tool;
Tool.Text = CurHigh;
            

sc.FormatString()

Type: Function

SCString& FormatString(SCString& Out, const char* Format, [Variable list of parameters]);

The sc.FormatString() function creates a text string using the specified Format. For more information, refer to the Setting A Name To A Formatted String section. Out is the SCString you need to provide where the text output is copied to.

SCString Output;

sc.FormatString(Output, "The result is: %f", sc.Subgraph[0].Data[sc.Index]);
            

sc.FormattedEvaluate()

Type: Function

int FormattedEvaluate(float Value1, int Value1Format, OperatorEnum Operator, float Value2, int Value2Format, float PrevValue1 = 0.0f, float PrevValue2 = 0.0f);

sc.FormattedEvaluate() evaluates the relationship between 2 floating-point numbers using the specified Operator and Value Formats (Value1Format, Value2Format). The evaluation is performed as follows: Value1 Operator Value2.

The more precise of the two Value Formats is used for the comparison. Once this is determined, half of the more precise Value Format is calculated. If the Value Format is 2 which is equivalent to .01, then the tolerance is .005. In this particular example, two values would be considered equal if the difference between them is less than .005.

Another example: Assuming the most precise Value Format is .01, Value1 will be considered less than Value2 if the difference between the two of them is less than -.005.

The function returns 1 if the evaluation is TRUE, and 0 if it is FALSE.

The reason why this function needs to be used when performing floating-point number comparisons is due to what is known as floating point error. Refer to Accuracy Problems in the Floating Point Wikipedia article. For example, the number .01 may internally be represented in a single precision floating-point variable as .0099998, therefore making comparisons using the built-in operators of the C++ language not accurate.

int Return = sc.FormattedEvaluate(CurrentClose, sc.BaseGraphValueFormat, LESS_OPERATOR, PriorLow, sc.BaseGraphValueFormat);
            

sc.FormattedEvaluateUsingDoubles()

Type: Function

int FormattedEvaluateUsingDoubles(double Value1, int Value1Format, OperatorEnum Operator, double Value2, int Value2Format, double PrevValue1 = 0.0f, double PrevValue2 = 0.0f);

sc.FormattedEvaluateUsingDoubles() evaluates the relationship between 2 double precision floating-point numbers using the specified Operator and Value Formats (Value1Format, Value2Format).

This function is identical to sc.FormattedEvaluate() except that it uses double precision floating-point numbers instead of single precision floating-point numbers.

For additional details, refer to sc.FormattedEvaluate().

sc.FormatVolumeValue()

Type: Function

SCString sc.FormatVolumeValue(int64_t Volume, int VolumeValueFormat, int UseLargeNumberSuffix);

The sc.FormatVolumeValue() function formats an integer volume value into a text string. The result is returned as a SCString type.

sc.FourBarSymmetricalFIRFilter()

Type: Intermediate Study Calculation Function

SCFloatArrayRef FourBarSymmetricalFIRFilter(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut, int Index);

SCFloatArrayRef FourBarSymmetricalFIRFilter(SCFloatArrayRef FloatArrayIn, SCFloatArrayRef FloatArrayOut); Auto-looping only.

The sc.FourBarSymmetricalFIRFilter() function calculates a four-bar smoothing of data and is frequently used in the studies written by John Ehlers.

sc.FourBarSymmetricalFIRFilter(sc.BaseDataIn[SC_LAST], sc.Subgraph[0]);

float FourBarSymmetricalFIRFilter = sc.Subgraph[0][sc.Index]; //Access the function value at the current index
            

sc.FreeMemory()

Type: Function

void FreeMemory (void* Pointer);

The sc.FreeMemory function releases the memory allocated with the sc.AllocateMemory function.

sc.GetACSDrawingByIndex()

Type: Function

For complete documentation for the sc.GetACSDrawingByIndex function, refer to sc.GetACSDrawingByIndex().

sc.GetACSDrawingByLineNumber()

Refer to the sc.GetACSDrawingByLineNumber() section on the Using Tools from an Advanced Custom Study page for information on this function.

sc.GetACSDrawingsCount()

Refer to the sc.GetACSDrawingsCount() section on the Using Tools from an Advanced Custom Study page for information on this function.

sc.GetAskMarketDepthEntryAtLevel

Type: Function

int GetAskMarketDepthEntryAtLevel(s_MarketDepthEntry& DepthEntry, int LevelIndex);

sc.GetAskMarketDepthEntryAtLevel returns in the DepthEntry structure of type s_MarketDepthEntry, the ask side market depth data for the level specified by the LevelIndex variable for the symbol of the chart.

The function returns 1 if the function call was successful, otherwise 0.

To receive Market Depth data it is also necessary to set sc.UsesMarketDepthData to 1 in the study function. This normally should be placed in the sc.SetDefaults code block.

For an example to access market depth data, refer to the scsf_DepthOfMarketData() function in the /ACS_Source/studies.cpp file in the folder where Sierra Chart is installed to.

The s_MarketDepthEntry structure contains a Price member and an AdjustedPrice member. Normally these are the same price. However, when a Real-time Price Multiplier is set to a value other than 1.0 in a chart, then Price will contain the original unadjusted price and AdjustedPrice will contain the Price multiplied by the Real-time Price Multiplier.

struct s_MarketDepthEntry
{
	float Price;
	t_MarketDataQuantity Quantity;
	uint32_t NumOrders;
    float AdjustedPrice;
}

            

sc.GetAskMarketDepthEntryAtLevelForSymbol

Type: Function

int GetAskMarketDepthEntryAtLevelForSymbol(const SCString& Symbol, s_MarketDepthEntry& r_DepthEntry, int LevelIndex);

sc.GetAskMarketDepthEntryAtLevelForSymbol returns in the DepthEntry structure of type s_MarketDepthEntry, the ask side market depth data for the level specified by the LevelIndex variable for the specified Symbol.

The function returns 1 if the function call was successful, otherwise 0.

To receive Market Depth data it is also necessary to set sc.UsesMarketDepthData to 1 in the study function. This normally should be placed in the sc.SetDefaults code block.

For an example to access market depth data, refer to the scsf_DepthOfMarketData() function in the /ACS_Source/studies.cpp file in the folder where Sierra Chart is installed to.

                struct s_MarketDepthEntry
                {
                    float Price;
                    t_MarketDataQuantity Quantity;
                    uint32_t NumOrders;
                    float AdjustedPrice; 
                }

            

sc.GetAskMarketDepthNumberOfLevels

Type: Function

int GetAskMarketDepthNumberOfLevels();

The sc.GetAskMarketDepthNumberOfLevels function returns the number of available market depth levels on the Ask side for the symbol of the chart.

There are settings which affect the number of market depth levels. Refer to Not Receiving the Full Number of Market Depth Levels.

sc.GetAskMarketDepthNumberOfLevelsForSymbol

Type: Function

int GetAskMarketDepthNumberOfLevelsForSymbol(const SCString& Symbol);

The sc.GetAskMarketDepthNumberOfLevelsForSymbol function returns the number of available market depth levels on the Ask side for the specified symbol.

There are settings which affect the number of market depth levels. Refer to Not Receiving the Full Number of Market Depth Levels.

 
int NumberOfLevels = GetAskMarketDepthNumberOfLevelsForSymbol(sc.Symbol);
            

sc.GetAskMarketDepthStackPullSum()

sc.GetBidMarketDepthStackPullSum()

Type: Function

double GetAskMarketDepthStackPullSum();

double GetBidMarketDepthStackPullSum();

The sc.GetAskMarketDepthStackPullSum and sc.GetBidMarketDepthStackPullSum functions return the current total sum of the market depth data stacking or pulling values for either the Ask or Bid side respectively.

For these functions to return a value, it is necessary that Trade >> Trading Chart DOM On / Show Market Data Columns is enabled for one of the charts for the Symbol. And one of the Pulling/Stacking columns needs to be added. Refer to Customize Trade/Chart DOM Columns and Descriptions for instructions.

 
// Get the current stacking and pulling sum on the Ask side
int MarketDepthStackPullSum = sc.GetAskMarketDepthStackPullSum();
            

sc.GetAskMarketDepthStackPullValueAtPrice()

sc.GetBidMarketDepthStackPullValueAtPrice()

Type: Function

int GetAskMarketDepthStackPullValueAtPrice(float Price);

int GetBidMarketDepthStackPullValueAtPrice(float Price);

The sc.GetAskMarketDepthStackPullValueAtPrice and sc.GetBidMarketDepthStackPullValueAtPrice functions return the current market depth data stacking or pulling value for either the Ask or Bid side respectively, for the given Price parameter.

For these functions to return a value, it is necessary that Trade >> Trading Chart DOM On / Show Market Data Columns is enabled for one of the charts for the Symbol. And one of the Pulling/Stacking columns needs to be added. Refer to Customize Trade/Chart DOM Columns and Descriptions for instructions.

Also refer to sc.GetAskMarketDepthStackPullSum() and sc.GetBidMarketDepthStackPullSum().

 
// Get the current stacking and pulling value on the bid side for the current best bid price.            
int StackPullValue = sc.GetBidMarketDepthStackPullValueAtPrice(sc.Bid);
            

sc.GetAskMarketLimitOrdersForPrice()

Type: Function

int GetAskMarketLimitOrdersForPrice(const int PriceInTicks, const int ArraySize, n_ACSIL::s_MarketOrderData* p_MarketOrderDataArray);

The sc.GetAskMarketLimitOrdersForPrice function is used to get the order ID and order quantity for working limit orders from the market data feed at the specified price level. This data is called Market by Order data. This includes all the working limit orders as provided by the market data feed.

sc.GetAttachedOrderIDsForParentOrder()

Type: Function

void GetAttachedOrderIDsForParentOrder(int ParentInternalOrderID, int& TargetInternalOrderID, int& StopInternalOrderID);

The sc.GetAttachedOrderIDsForParentOrder function is used to get the Internal Order IDs for a Target and Stop order for a given Parent Internal Order ID.

The ParentInternalOrderID parameter specifies the Parent Internal Order ID. The TargetInternalOrderID, StopInternalOrderID parameters receive the Target and Stop Internal Order IDs respectively.

For information about Internal Order IDs, refer to the ACSIL Trading page. These Internal Order IDs can be obtained when submitting an order.

int TargetInternalOrderID = -1;
int StopInternalOrderID = -1;

//This needs to be set to the parent internal order ID search for. Since we do not know what that is in this code example, it is set to zero here.
int ParentInternalOrderID = 0;

sc.GetAttachedOrderIDsForParentOrder(ParentInternalOrderID, TargetInternalOrderID, StopInternalOrderID)
            

sc.GetBarHasClosedStatus()

Type: Function

int GetBarHasClosedStatus(int BarIndex);

int GetBarHasClosedStatus(); Auto-looping only.

The sc.GetBarHasClosedStatus function is used to determine if the data for a particular bar in the sc.BaseData[][] arrays at the specified BarIndex parameter (required for manual looping), has completed and will no longer be updated during real-time or replay updating.

This is useful when you only want to perform calculations on a fully completed bar. It is equivalent to "Signal Only on Bar Close" with the Spreadsheet studies.

This function has several return values described below.

Refer to the scsf_GetBarHasClosedStatusExample() function in the /ACS_Source/studies.cpp file in the Sierra Chart installation folder for example code to work with this function.

This function can be used with manual or automatic looping. It can be given an index of any bar. sc.BaseData[][] contains the underlying bar data for the chart. In this function call: sc.GetBarHasClosedStatus(sc.Index), sc.Index is passed through the BarIndex parameter and this will refer to the bar data at sc.BaseData[][sc.Index].

The very last bar in the chart is never considered a closed bar until there is a new bar added to the chart. It is not possible to know otherwise because of the following reasons: The chart bars are based upon a variable timeframe like Number of Trades or Volume and the ending can never be known until there is a new bar, or because there is not a trade at the very final second of a fixed time bar.

In the case of chart bars which are based upon a fixed amount of time, the only way to know when the end of that chart bar has occurred, is to consider the time length of the bar through sc.SecondsPerBar. Use sc.UpdateAlways, to have the study function periodically and continuously called. And use the current Date-Time through sc.GetCurrentDateTime() to know when the bar is considered closed.

Return Values:

• BHCS_BAR_HAS_CLOSED: Element at BarIndex has closed. This will always be returned for any bar in the chart other than the last bar in the chart.
• BHCS_BAR_HAS_NOT_CLOSED: Element at BarIndex has not closed. This will always be returned for the last bar in the chart.
• BHCS_SET_DEFAULTS: Configuration and defaults are being set. Allow the sc.SetDefaults code block to run. Bar has closed status is not available.

if(sc.GetBarHasClosedStatus(Index)==BHCS_BAR_HAS_NOT_CLOSED)
{

    return;//do not do any processing if the bar at  the current index has not closed
}
            

sc.GetBarPeriodParameters()

Type: Function

void GetBarPeriodParameters(n_ACSIL::s_BarPeriod& r_BarPeriod)

The sc.GetBarPeriodParameters() function copies the chart bar period parameters into the structure of type n_ACSIL::s_BarPeriod which is passed to the function as r_BarPeriod. Refer to the example below.

When using sc.SetBarPeriodParameter() to change the period for a chart bar, and then making a call to sc.GetBarPeriodParameters() immediately after, but during the processing in the study function, it will then return these new set parameters.

The n_ACSIL::s_BarPeriod structure members are the following:

• s_BarPeriod::ChartDataType: Can be one of the following:
  • DAILY_DATA = 1
  • INTRADAY_DATA = 2.
• s_BarPeriod::HistoricalChartBarPeriodType: Can be one of the following:
  • HISTORICAL_CHART_PERIOD_DAYS = 1
  • HISTORICAL_CHART_PERIOD_WEEKLY = 2
  • HISTORICAL_CHART_PERIOD_MONTHLY = 3
  • HISTORICAL_CHART_PERIOD_QUARTERLY = 4
  • HISTORICAL_CHART_PERIOD_YEARLY = 5
• s_BarPeriod::HistoricalChartDaysPerBar: When s_BarPeriod::HistoricalChartBarPeriodType is set to HISTORICAL_CHART_PERIOD_DAYS, then this specifies the number of days per historical chart bar.
• s_BarPeriod::IntradayChartBarPeriodType: The type of bar period that is being used in the case of an Intraday chart. To determine the chart data type, use s_BarPeriod::ChartDataType. For example, this would be set to the enumeration value IBPT_DAYS_MINS_SECS if the Intraday Chart Bar Period Type is set to Days-Minutes-Seconds. Can be any of the following constants:
  • IBPT_DAYS_MINS_SECS = 0: s_BarPeriod::IntradayChartBarPeriodParameter1 is the number of seconds in one bar in an Intraday chart. This is set by the Days-Mins-Secs setting in the Chart >> Chart Settings window for the chart. For example, for a 1 Minute chart this will be set to 60. For a 30 Minute chart this will be set to 1800.
  • IBPT_VOLUME_PER_BAR = 1
  • IBPT_NUM_TRADES_PER_BAR = 2
  • IBPT_RANGE_IN_TICKS_STANDARD = 3
  • IBPT_RANGE_IN_TICKS_NEWBAR_ON_RANGEMET = 4
  • IBPT_RANGE_IN_TICKS_TRUE = 5
  • IBPT_RANGE_IN_TICKS_FILL_GAPS = 6
  • IBPT_REVERSAL_IN_TICKS = 7
  • IBPT_RENKO_IN_TICKS = 8
  • IBPT_DELTA_VOLUME_PER_BAR = 9
  • IBPT_FLEX_RENKO_IN_TICKS = 10
  • IBPT_RANGE_IN_TICKS_OPEN_EQUAL_CLOSE = 11
  • IBPT_PRICE_CHANGES_PER_BAR = 12
  • IBPT_MONTHS_PER_BAR = 13
  • IBPT_POINT_AND_FIGURE = 14
  • IBPT_FLEX_RENKO_IN_TICKS_INVERSE_SETTINGS = 15
  • IBPT_ALIGNED_RENKO = 16
  • IBPT_RANGE_IN_TICKS_NEW_BAR_ON_RANGE_MET_OPEN_EQUALS_PRIOR_CLOSE = 17
  • IBPT_ACSIL_CUSTOM = 18: This is used when the chart contains an advanced custom study that creates custom chart bars. The study name is contained within s_BarPeriod::ACSILCustomChartStudyName. For complete documentation for building custom chart bars, refer to ACSIL Interface - Custom Chart Bars.
  • IBPT_HISTORICAL_DAILY_DATA_DAYS_PER_BAR = 10000
• s_BarPeriod::IntradayChartBarPeriodParameter1: The first parameter for the bar period that is being used. In the case of IntradayChartBarPeriodType being set to IBPT_DAYS_MINS_SECS, this will be set to the number of seconds. In the case of IntradayChartBarPeriodType being set IBPT_FLEX_RENKO_IN_TICKS, this would be the Bar Size value in ticks.
• s_BarPeriod::IntradayChartBarPeriodParameter2: The second parameter for the bar period that is being used. For example, this would be the Trend Offset value when using IBPT_FLEX_RENKO_IN_TICKS for the Intraday Chart Bar Period Type. If this parameter is unused for the Intraday Chart Bar Period Type, then the value is set to 0.
• s_BarPeriod::IntradayChartBarPeriodParameter3: The third parameter for the bar period that is being used. For example, this would be the Reversal Offset value when using IBPT_FLEX_RENKO_IN_TICKS for the Intraday Chart Bar Period Type. If this parameter is unused for the Intraday Chart Bar Period Type, then the value is set to 0.
• s_BarPeriod::IntradayChartBarPeriodParameter4: The fourth parameter for the bar period that is being used. For example, this would be the Renko New Bar Mode setting when using any of the Renko Intraday Chart Bar Period Types. If this parameter is unused for the Intraday Chart Bar Period Type, then the value is set to 0. The values for Renko New Bar Mode are listed below.
  • NEW_TREND_BAR_WHEN_EXCEEDED_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET = 0
  • NEW_TREND_BAR_WHEN_EXCEEDED_NEW_BAR_WHEN_OPEN_CROSSED = 1
  • NEW_TREND_BAR_WHEN_EXCEEDED_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET_PLUS_1_TICK = 2
  • NEW_TREND_BAR_WHEN_RANGE_MET_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET = 3
  • NEW_TREND_BAR_WHEN_RANGE_MET_NEW_BAR_WHEN_OPEN_CROSSED = 4
  • NEW_TREND_BAR_WHEN_RANGE_MET_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET_PLUS_1_TICK = 5
  • NEW_TREND_BAR_AFTER_RANGE_MET_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET = 6
  • NEW_TREND_BAR_AFTER_RANGE_MET_NEW_BAR_WHEN_OPEN_CROSSED = 7
  • NEW_TREND_BAR_AFTER_RANGE_MET_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET_PLUS_1_TICK = 8
  • NEW_TREND_BAR_AFTER_RANGE_MET_ALLOW_CHANGE_OF_DIRECTION_OF_CURRENT_BAR = 9
  • NEW_TREND_BAR_AFTER_RANGE_MET_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET_FIRST_TREND_BAR_SAME_LENGTH_REVERSAL = 10
  • NEW_TREND_BAR_WHEN_EXCEEDED_NEW_REVERSAL_BAR_WHEN_REVERSAL_AMOUNT_MET_PLUS_1_TICK_FIRST_TREND_BAR_SAME_LENGTH_REVERSAL = 11
• s_BarPeriod::ACSILCustomChartStudyName: When the chart contains an advanced custom study that creates custom chart bars, this contains the name as a texturing of the custom study which creates those custom chart bars. The name is set through sc.GraphName.
  
  For complete documentation for building custom chart bars, refer to ACSIL Interface - Custom Chart Bars.

n_ACSIL::s_BarPeriod BarPeriod;
sc.GetBarPeriodParameters(BarPeriod);
if (BarPeriod.ChartDataType == INTRADAY_DATA && BarPeriod.IntradayChartBarPeriodType == IBPT_DAYS_MINS_SECS)
{
    int SecondsPerBar = BarPeriod.IntradayChartBarPeriodParameter1;
}        
            

sc.GetBarsSinceLastTradeOrderEntry()

Type: Function

int GetBarsSinceLastTradeOrderEntry()

This function returns the number of chart bars counting from the end of the chart since the Date-Time of the last entry trade order for the Symbol and Trade Account of the chart the study is applied to, whether the order was from ACSIL or not.

If there has been no entry order or the entry was on the last bar of the chart, then this function returns 0.

sc.GetBarsSinceLastTradeOrderExit()

Type: Function

int GetBarsSinceLastTradeOrderExit()

This function returns the number of chart bars counting from the end of the chart since the Date-Time of the last exit trade order for the Symbol and Trade Account of the chart the study is applied to, whether the order was from ACSIL or not.

If there has been no exit order or the exit was on the last bar of the chart, then this function returns 0.

sc.GetBasicSymbolData()

Type: Function

void GetBasicSymbolData(const char* Symbol, s_SCBasicSymbolData& BasicSymbolData, bool Subscribe)

The sc.GetBasicSymbolData will fill out the BasicSymbolData data structure with all of the Current Quote data for the specified Symbol. This data is only considered valid when connected to the data feed. The Current Quote data is the data that is found in Window >> Current Quote Window. Market Depth data is also included in the data structure.

Refer to declaration of s_SCBasicSymbolData in the /ACS_Source/scsymboldata.h file in the folder Sierra Chart is installed to for all of the structure members. The data that is returned when calling this function is the most current available data.

The Subscribe parameter will subscribe to market data for the symbol when connected to the data feed. Subscribing to a symbol, does not mean that the study function will be called for all updates on the symbol. The study function will only be called based upon the updates of the symbol of the chart the study instance is on.

As an example, you could have a list of 10 symbols to request data for by calling sc.GetBasicSymbolData() for each symbol. After each call, examine the returned data and do any required calculations. So in this scenario, you can form an index by adding all of the last price values together and dividing by 10, and placing the results in a sc.Subgraph[].Data[] array.

// Get the daily high price for another symbol. The first time this  
// function is called after connecting to the data feed, the symbol data 
// will not be available initially. Once the data becomes available, when  
// this function is called after, the symbol data will be available.  If  
// this study is used on a chart for a symbol which does not frequently  
// update, then it will be a good idea to set sc.UpdateAlways = 1. 
const char * Symbol = "ABC"; 
s_SCBasicSymbolData BasicSymbolData; 
sc.GetBasicSymbolData(Symbol,BasicSymbolData, true); 
float DailyHigh = BasicSymbolData.High;

float LatestAsk = BasicSymbolData.Ask;// Also refer to the latest ask price
            

sc.GetBasicSymbolDataWithDepthSupport

Type: Function

void GetBasicSymbolDataWithDepthSupport(const char* Symbol, s_SCBasicSymbolData& BasicSymbolData, int SubscribeToData, int SubsribeToMarketDepth);

The sc.GetBasicSymbolDataWithDepthSupport() function is identical to the sc.GetBasicSymbolData function.

The difference is that it supports subscribing to market depth data.

sc.GetBidMarketDepthEntryAtLevel

Type: Function

int GetBidMarketDepthEntryAtLevel(s_MarketDepthEntry& DepthEntry, int LevelIndex);

sc.GetBidMarketDepthEntryAtLevel returns in the DepthEntry structure of type s_MarketDepthEntry, the bid side market depth data for the level specified by the LevelIndex variable for the symbol of the chart.

The function returns 1 if the function call was successful, otherwise 0.

To receive Market Depth data it is also necessary to set sc.UsesMarketDepthData to 1 in the study function. This normally should be placed in the sc.SetDefaults code block.

For an example to access market depth data, refer to the scsf_DepthOfMarketData() function in the /ACS_Source/studies.cpp file in the folder where Sierra Chart is installed to.

The s_MarketDepthEntry structure contains a Price member and an AdjustedPrice member. Normally these are the same price. However, when a Real-time Price Multiplier is set to a value other than 1.0 in a chart, then Price will contain the original unadjusted price and AdjustedPrice will contain the Price multiplied by the Real-time Price Multiplier.

struct s_MarketDepthEntry
{
	float Price;
	t_MarketDataQuantity Quantity;
	uint32_t NumOrders;
    float AdjustedPrice; 
}

            

sc.GetBidMarketDepthEntryAtLevelForSymbol

Type: Function

int GetBidMarketDepthEntryAtLevelForSymbol(const SCString& Symbol, s_MarketDepthEntry& r_DepthEntry, int LevelIndex);

sc.GetBidMarketDepthEntryAtLevelForSymbol returns in the DepthEntry structure of type s_MarketDepthEntry, the bid side market depth data for the level specified by the LevelIndex variable for the specified Symbol.

The function returns 1 if the function call was successful, otherwise 0.

To receive Market Depth data it is also necessary to set sc.UsesMarketDepthData to 1 in the study function. This normally should be placed in the sc.SetDefaults code block.

For an example to access market depth data, refer to the scsf_DepthOfMarketData() function in the /ACS_Source/studies.cpp file in the folder where Sierra Chart is installed to.

                struct s_MarketDepthEntry
                {
                    float Price;
                    t_MarketDataQuantity Quantity;
                    uint32_t NumOrders;
                    float AdjustedPrice; 
                }

            

sc.GetBidMarketDepthNumberOfLevels

Type: Function

int GetBidMarketDepthNumberOfLevels();

The sc.GetBidMarketDepthNumberOfLevels function returns the number of available market depth levels on the Bid side for the symbol of the chart.

There are settings which affect the number of market depth levels. Refer to Not Receiving the Full Number of Market Depth Levels.

sc.GetBidMarketDepthNumberOfLevelsForSymbol

Type: Function

int GetBidMarketDepthNumberOfLevelsForSymbol(const SCString& Symbol);

The sc.GetBidMarketDepthNumberOfLevelsForSymbol function returns the number of available market depth levels on the Bid side for the specified symbol.

There are settings which affect the number of market depth levels. Refer to Not Receiving the Full Number of Market Depth Levels.

 
int NumberOfLevels = GetBidMarketDepthNumberOfLevelsForSymbol(sc.Symbol);
            

sc.GetBidMarketLimitOrdersForPrice

Type: Function

int GetBidMarketLimitOrdersForPrice(const int PriceInTicks, const int ArraySize, n_ACSIL::s_MarketOrderData* p_MarketOrderDataArray);

The sc.GetBidMarketLimitOrdersForPrice function is used to get the order ID and order quantity for working limit orders from the market data feed at the specified price level. This data is called Market by Order data. This includes all the working limit orders as provided by the market data feed.

sc.GetBuiltInStudyName

Type: Function

int GetBuiltInStudyName(const int InternalStudyIdentifier, SCString& r_StudyName);

The sc.GetBuiltInStudyName function .

sc.GetCalculationStartIndexForStudy()

Type: Function

int GetCalculationStartIndexForStudy();

The sc.GetCalculationStartIndexForStudy() function returns the starting index where a study function needs to begin its calculations at when it has a dependency on a study which has started a calculation at an earlier start index than normal. This function is for specialized purposes. It is not normally used.

For example, the Zig Zag study during a chart update may change the Zig Zag line at a chart bar index which is earlier than the chart bar being updated and any new bars added to the chart.

Any study function which uses this function, must use Manual Looping.

For a related variable, also refer to sc.EarliestUpdateSubgraphDataArrayIndex.

int CalculationStartIndex = sc.GetCalculationStartIndexForStudy();

for (int Index = CalculationStartIndex; Index < sc.ArraySize; Index++)
{

    float BasedOnStudySubgraphValue = sc.BaseData[InputData.GetInputDataIndex()][Index];

    if (AddToZeroValuesInBasedOnStudy.GetYesNo() == 0 && BasedOnStudySubgraphValue == 0.0)
    {
        Result[Index] = 0.0;
    }
    else
        Result[Index] = BasedOnStudySubgraphValue + AmountToAdd.GetFloat();
}

sc.EarliestUpdateSubgraphDataArrayIndex = CalculationStartIndex;   
            

sc.GetChartArray()

Type: Function

GetChartArray(int ChartNumber, int InputData, SCFloatArrayRef PriceArray);

sc.GetChartArray() is for accessing the main/primary base graph data in other loaded charts in the same chartbook containing the chart that your study function is applied to. This is an older function and it is highly recommended that you use sc.GetChartBaseData instead. See the scsf_GetChartArrayExample() function in the studies.cpp file in the ACS_Source folder in the Sierra Chart installation folder for example code to work with this function.

SCFloatArray PriceArray;

// Get the close/last array from chart #1

sc.GetChartArray(1, SC_LAST, PriceArray);

// The PriceArray may not exist or is empty. Either way we can not do anything with it.
if (PriceArray.GetArraySize() == 0)

    return;
            

sc.GetChartBaseData()

Type: Function

GetChartBaseData(int ChartNumber, SCGraphData & BaseData);

The sc.GetChartBaseData() function is for accessing all of the main/primary Base Data arrays in another loaded chart in the same Chartbook as the one containing the chart that your custom study function is applied to which calls this function.

The main Base Data arrays refer to the arrays of the main price graph in a chart. If the main price graph has been replaced by using a custom chart study such as the Point and Figure chart study, then this function will get this new main price graph from the specified ChartNumber.

Refer to the example below. For a complete working example, refer to Referencing Other Time Frames and Symbols When Using the ACSIL.

For information about getting the corresponding index in the arrays returned, refer to Accessing Correct Array Indexes in Other Chart Arrays.

When you are getting data from another chart with this function, this other chart during a chart replay may not have the data which is up to date to the time of the chart containing the study calling the sc.GetChartBaseData function.

// The following code is for getting the High array
// and corresponding index from another chart.

// Define a graph data object to get all of the base graph data
SCGraphData BaseGraphData;

// Get the base graph data from the specified chart
sc.GetChartBaseData(ChartNumber.GetInt(), BaseGraphData);

// Define a reference to the High array
SCFloatArrayRef HighArray = BaseGraphData[SC_HIGH];

// Array is empty. Nothing to do.
if(HighArray.GetArraySize() == 0)

return;

// Get the index in the specified chart that is
// nearest to current index.
int RefChartIndex =
sc.GetNearestMatchForDateTimeIndex(ChartNumber.GetInt(), sc.Index);

float NearestRefChartHigh = HighArray[RefChartIndex];
            

sc.GetChartDateTimeArray()

Type: Function

GetChartDateTimeArray(int ChartNumber, SCDateTimeArray& DateTimeArray);

sc.GetChartDateTimeArray() is used to access the SCDateTime array (sc.BaseDateTimeIn[]) in other loaded charts in the same chartbook containing the chart that your study is applied to. See the scsf_GetChartArrayExample() function in the studies.cpp file inside the ACS_Source folder inside of the Sierra Chart installation folder for example code to work with this function.

SCDateTimeArray DateTimeArray;

// Get the DateTime array from chart #1
sc.GetChartDateTimeArray(1, DateTimeArray);

// The array may not exist or is empty. Either way we can not do anything with it.
if (DateTimeArray.GetArraySize() == 0)
    return;
            

sc.GetChartDrawing()

Type: Function

For more information, refer to the sc.GetUserDrawnChartDrawing() section on the Using Tools From an Advanced Custom Study page.

sc.GetChartFontProperties()

Type: Function

int GetChartFontProperties(SCString& r_FontName, int32_t& r_FontSize, int32_t& r_FontBold, int32_t& r_FontUnderline, int32_t& r_FontItalic);

The sc.GetChartFontProperties function gets the information for the Chart Text Font that is in use for the chart associated with the study from which this function is called.

The function returns a value of 1 if it is able to successfully get the Chart Text Font information, otherwise it returns a value of 0.

sc.GetChartName()

Type: Function

SCString GetChartName(int ChartNumber);

The sc.GetChartName function, returns the name of the chart specified by the ChartNumber parameter.

It is only possible to access charts which are in the same Chartbook as the chart containing the study function which is calling this function.

The name contains the symbol of the chart as well as the timeframe per bar and the chart number.

For an example of how to use this function, refer to the scsf_Spread3Chart function in the /ACS_Source/studies7.cpp file in the folder where Sierra Chart is installed to.

SCString Chart1Name = sc.GetChartName(sc.ChartNumber);
            

sc.GetChartReplaySpeed()

Type: Function

float GetChartReplaySpeed(int ChartNumber);

sc.GetChartStudyInputChartStudySubgraphValues()

Type: Function

int GetChartStudyInputChartStudySubgraphValues(int ChartNumber, int StudyID, int InputIndex, s_ChartStudySubgraphValues& r_ChartStudySubgraphValues);

The sc.GetChartStudyInputChartStudySubgraphValues function gets the study Input value as a s_ChartStudySubgraphValues structure from the specified Chart Number and Study ID.

This function works with ChartStudySubgraphValue Input types.

The function returns 1 if successful. Otherwise, 0.

s_ChartStudySubgraphValues ChartStudySubgraphValues;

sc.GetChartStudyInputChartStudySubgraphValues(sc.ChartNumber, 1, 1, ChartStudySubgraphValues);			
            

sc.GetChartStudyInputFloat()

Type: Function

int GetChartStudyInputFloat(int ChartNumber, int StudyID, int InputIndex, double& r_FloatValue);

The sc.GetChartStudyInputFloat function gets the study Input value as a double from the specified Chart Number and Study ID.

This function works with all Input types and returns the value as a double. The necessary conversions are automatically made.

When working with Date and Time Inputs which use SCDateTime, use this function for getting the value of the Date and Time Input as a double. See the example below to set this into a SCDateTime variable.

The function returns 1 if successful. Otherwise, 0.

double FloatInput = 0;
sc.GetChartStudyInputFloat(sc.ChartNumber, 1, 1, FloatInput);

// If the above is obtaining the value from a Date and Time type of Input, then the following code will set this into a SCDateTime variable
SCDateTime DateTimeFromInput;
DateTimeFromInput.SetDateTimeAsDouble(FloatInput);
            

sc.SetChartStudyInputFloat()

Type: Function

int SetChartStudyInputFloat(int ChartNumber, int StudyID, int InputIndex, double FloatValue);

The sc.SetChartStudyInputFloat function sets the study Input value as a double data type in the specified Chart Number and Study ID.

This function works with all Input types and sets the value as a double. The necessary conversions are automatically made.

When working with Date and Time Inputs which use SCDateTime, use this function for setting them. See the example below for how to set a specific Date and Time into a Date and Time study Input.

After changing a study Input, in most cases you will need to recalculate the chart the study is on in order for the new Input to be used. But this depends upon how the study is using it. If it is a study that you have developed and you know that a recalculation is not necessary, then this is not necessary. To recalculate the chart, use the sc.RecalculateChart() function.

The function returns 1 if successful. Otherwise, 0.

int Result = sc.SetChartStudyInputFloat(sc.ChartNumber, 1, 1, 1.5);

//Example to set study (with ID 2) Date-Time Input (with index 1), to a specific Date-Time
SCDateTime NewDateTimeForInput;
NewDateTimeForInput.SetDateTimeYMDHMS_MS(2024, 7, 1, 13, 5, 0, 0);

sc.SetChartStudyInputFloat(sc.ChartNumber, 2, 1, NewDateTimeForInput.GetAsDouble());           
            

sc.GetChartStudyInputInt()

Type: Function

int GetChartStudyInputInt(int ChartNumber, int StudyID, int InputIndex, int& r_IntegerValue);

The sc.GetChartStudyInputInt function gets the study Input value as an integer from the specified Chart Number and Study ID.

This function works with all Input types and returns the value as an integer. The necessary conversions are automatically made.

The function returns 1 if successful. Otherwise, 0.

	int IntegerInput = 0;
	sc.GetChartStudyInputInt(sc.ChartNumber, 1, 1, IntegerInput);
            

sc.SetChartStudyInputInt()

Type: Function

int SetChartStudyInputInt(int ChartNumber, int StudyID, int InputIndex, int IntegerValue);

The sc.SetChartStudyInputInt function sets the study Input value as an integer in the specified Chart Number and Study ID.

This function works with all Input types and sets the value using an integer. The necessary conversions are automatically made.

After changing a study Input, in most cases you will need to recalculate the chart the study is on in order for the new Input to be used. But this depends upon how the study is using it. If it is a study that you have developed and you know that a recalculation is not necessary, then this is not necessary. To recalculate the chart, use the sc.RecalculateChart() function.

Another reason why you would not have to do a recalculate with sc.RecalculateChart() is if after changing a study Input you are then starting a replay for the chart using the sc.StartChartReplayNew() function.

The function returns 1 if successful. Otherwise, 0.

            int Result = sc.SetChartStudyInputInt(sc.ChartNumber, 1, 1, 20);
            

sc.GetChartStudyInputString()

Type: Function

int GetChartStudyInputString(int ChartNumber, int StudyID, int InputIndex, SCString& r_StringValue);

The sc.GetChartStudyInputString function gets the study Input value as a text string from the specified Chart Number and Study ID.

This function works with only string Input types and returns the value as a string.

The function returns 1 if successful. Otherwise, 0.

	SCString StringInput;
	sc.GetChartStudyInputString(sc.ChartNumber, 1, 1, StringInput);
            

sc.GetChartStudyInputType()

Type: Function

int GetChartStudyInputType(int ChartNumber, int StudyID, int InputIndex);

The sc.GetChartStudyInputType function

sc.SetChartStudyInputString()

Type: Function

int SetChartStudyInputString(int ChartNumber, int StudyID, int InputIndex, const SCString& StringValue);

The sc.SetChartStudyInputString function sets the study Input with the specified text string in the specified Chart Number and Study ID.

This function works only with string Input types. If the Input is not already a string, then the function will return 0 and does nothing.

After changing a study Input, in most cases you will need to recalculate the chart the study is on in order for the new Input to be used. But this depends upon how the study is using it. If it is a study that you have developed and you know that a recalculation is not necessary, then this is not necessary. To recalculate the chart, use the sc.RecalculateChart() function.

The function returns 1 if successful. Otherwise, 0.

            int Result = sc.SetChartStudyInputString(sc.ChartNumber, 1, 1, "My Text String");
            

sc.SetChartStudyTransparencyLevel()

Type: Function

int32_t SetChartStudyTransparencyLevel(int32_t ChartNumber, int32_t StudyID, const int32_t TransparencyLevel);

The sc.SetChartStudyTransparencyLevel() function sets the current transparency level (0 to 100) for Draw Styles which use transparency for the study specified by the ChartNumber and StudyID parameters.

The TransparencyLevel parameter sets the transparency level. This can be a value anywhere from 0 to 100.

sc.SetChartTradeMode()

Type: Function

int SetChartTradeMode(int ChartNumber, int Enabled);

The sc.SetChartTradeMode function enables or disables chart trade mode, for the specified ChartNumber.

sc.SetChartTradeMode(sc.ChartNumber, 1);
            

sc.GetChartStudyTransparencyLevel()

Type: Function

int32_t GetChartStudyTransparencyLevel(int32_t ChartNumber, int32_t StudyID);

The sc.GetChartStudyTransparencyLevel() function gets the current transparency level (0 to 100) for Draw Styles which use transparency for the study specified by the ChartNumber and StudyID parameters.

sc.GetChartSymbol()

Type: Function

SCString GetChartSymbol(int ChartNumber);

The sc.GetChartSymbol() function returns as a text string of type SCString, the symbol of the chart specified by the ChartNumber parameter. To get the symbol of the chart the study instance is applied to, specify sc.ChartNumber for the ChartNumber parameter.

If the returned text string is blank, this indicates the chart does not exist.

sc.GetChartTextFontFaceName()

Type: Function

SCString sc.GetChartTextFontFaceName();

The sc.GetChartTextFontFaceName() function returns the font name as a text string of the font that the chart the study instance is applied to, is set to use.

Tool.FontFace = sc.GetChartTextFontFaceName();
            

sc.GetChartTimeZone()

Type: Function

SCString sc.GetChartTimeZone(const int ChartNumber);

The sc.GetChartTimeZone() function .

sc.GetChartWindowHandle()

Type: Function

HWND sc.GetChartWindowHandle(int ChartNumber);

The sc.GetChartWindowHandle() function returns the window handle as an integer for the specified ChartNumber. Use version 1616 or higher to get the proper handle when using this function.

HWND WindowHandle = sc.GetChartWindowHandle(sc.ChartNumber)
            

sc.GetCombineTradesIntoOriginalSummaryTradeSetting()

Type: Function

int sc.GetCombineTradesIntoOriginalSummaryTradeSetting();

The sc.GetCombineTradesIntoOriginalSummaryTradeSetting() function

sc.GetContainingIndexForDateTimeIndex()

Type: Function

int GetContainingIndexForDateTimeIndex(int ChartNumber, int DateTimeIndex);

sc.GetContainingIndexForDateTimeIndex() returns the index into the Base Data arrays of the chart specified by ChartNumber that contains the Date-Time at the index, on the chart your study function is applied to, specified by DateTimeIndex. If the Date-Time at DateTimeIndex is before any Date-Time in the chart specified with ChartNumber, then the index of the first element is given which will be 0. If the Date-Time at DateTimeIndex is after any Date-Time in the chart specified with ChartNumber , then the index of the last element is given which will be sc.ArraySize - 1.

Containing means that the chart bar starting Date-Time and ending Date-Time in ChartNumber contains the Date-Time specified by the DateTimeIndex parameter.

This function can be used on the sc.BaseData[] arrays for the same chart that your study function is applied to when searching for the Date-Time. To do this, pass sc.ChartNumber for the ChartNumber parameter.

If ChartNumber is given as a negative number, the bar period and other Chart Settings are synchronized between the two charts. If it is positive, this does not occur. For example, if you want to get the index from chart #5, and you want to synchronize the charts, then use -5 for the ChartNumber parameter.

// Get the index in the Base Data arrays for chart #2 that contains
// the Date-Time at the current Index of the chart that this study
// is applied to.

int Chart2Index = sc.GetContainingIndexForDateTimeIndex(2, sc.Index);
            

sc.GetContainingIndexForSCDateTime()

Type: Function

int GetContainingIndexForSCDateTime(int ChartNumber, SCDateTime DateTime);

sc.GetContainingIndexForSCDateTime() returns the index into the Base Data arrays of the chart specified by ChartNumber that contains DateTime . If DateTime is before any Date-Time in the chart specified with ChartNumber, then the index of the first element is given which is 0. If DateTime is after any Date-Time in the chart specified with ChartNumber , then the index of the last element is given which is sc.ArraySize - 1.

Containing means that the chart bar starting Date-Time and ending Date-Time in ChartNumber contains the Date-Time specified by the DateTime parameter.

This function can be used on the sc.BaseData[] arrays for the same chart that your study function is applied to when searching for the Date-Time. To do this, pass sc.ChartNumber for the ChartNumber parameter.

If ChartNumber is given as a negative number, the bar period and other Chart Settings are synchronized between the two charts. If it is positive, this does not occur. For example, if you want to get the index from chart #5, and you want to synchronize the charts, then use -5 for the ChartNumber parameter.

// Get the index in the Base Data arrays for chart #2 that contains the specified Date-Time.

SCDateTime DateTime = sc.BaseDateTimeIn[sc.Index];

int Chart2Index = sc.GetContainingIndexForSCDateTime(2, DateTime);
            

sc.GetCorrelationCoefficient()

Type: Intermediate Study Calculation Function

float GetCorrelationCoefficient(SCFloatArrayRef FloatArrayIn1, SCFloatArrayRef FloatArrayIn2, int Index, int Length);

float GetCorrelationCoefficient(SCFloatArrayRef FloatArrayIn1, SCFloatArrayRef FloatArrayIn2, int Length); Auto-looping only.

The sc.GetCorrelationCoefficient() function calculates the Pearson product-moment correlation coefficient from the data in the FloatArrayIn1 and FloatArrayIn2 arrays. The result is returned as a single float value.

float Coefficient = sc.GetCorrelationCoefficient(sc.Subgraph[0], sc.Subgraph[1], 10);
            

sc.GetCountDownText()

Type: Function

SCString GetCountDownText();

The sc.GetCountDownText() function gets the current countdown timer text for the chart.

s_UseTool Tool;
Tool.Text.Format("%s",sc.GetCountDownText().GetChars());
            

sc.GetCurrentDateTime()

Type: Function

SCDateTime GetCurrentDateTime();

The sc.GetCurrentDateTime function returns an SCDateTime variable which indicates the current Date-Time in the time zone of the chart the study is applied to.

This is obtained from the local system time. So it can be inaccurate if your system time is not set accurately.

During a chart replay, this time is calculated by Sierra Chart based upon the starting Date-Time in the chart where the replay began, the actual elapsed time, and the replay speed. In this particular case you need to be careful when using the returned value. If your computer and Sierra Chart are not able to keep up with the amount of data that needs to be processed during a fast replay, then this Date-Time can be significantly ahead of the Date-Time of the most recent added bar during a chart replay.

During a chart replay, this function returns the same value as sc.CurrentDateTimeForReplay.

In general, this Date-Time should never be considered an accurate reference in relation to the last bar start or end Date-Time. And it should not be used during fast Back Testing because it would be inherently inaccurate and unstable because it is a calculated time based on time. The only built-in study which uses this is the Countdown Timer study and that is meant to be used for real-time updating and slow speed replays only and only provides indicative visual information.

To access the bar times themselves which is recommended, use the array sc.BaseDateTimeIn[] for the bar beginning times, and the array sc.BaseDataEndDateTime[] for the bar ending times.

Also refer to sc.LatestDateTimeForLastBar.

sc.GetCurrentTradedAskVolumeAtPrice()

Type: Function

uint32_t GetCurrentTradedAskVolumeAtPrice(float Price);

The sc.GetCurrentTradedAskVolumeAtPrice returns the Ask Volume traded at the given Price for the symbol of the chart of which the study instance that calls this function is applied to. For more detailed information, refer to Chart/Trade DOM Column Descriptions.

For this data to be up-to-date and available, there must be a connection to the data feed, or the chart needs to be replaying.

sc.GetCurrentTradedBidVolumeAtPrice()

Type: Function

uint32_t GetCurrentTradedBidVolumeAtPrice(float Price);

The sc.GetCurrentTradedBidVolumeAtPrice returns the Bid Volume traded at the given Price for the symbol of the chart of which the study instance that calls this function is applied to. For more detailed information, refer to Chart/Trade DOM Column Descriptions.

For this data to be up-to-date and available, there must be a connection to the data feed, or the chart needs to be replaying.

sc.GetCustomStudyControlBarButtonEnableState()

Type: Function

int sc.GetCustomStudyControlBarButtonEnableState()(int ControlBarButtonNum);

The GetCustomStudyControlBarButtonEnableState() function gets the enable state of the specified Advanced Custom Study Control Bar button.

Returns 1 if the button is enabled. Returns 0 if the button is disabled.

For further details about Advanced Custom study Control Bar buttons, refer to Advanced Custom Study Buttons and Pointer Events.

sc.GetDataDelayFromChart()

Type: Function

SCDateTime GetDataDelayFromChart(const int ChartNumber);

The GetDataDelayFromChart() function .

sc.GetDispersion()

Type: Intermediate Study Calculation Function

float GetDispersion(SCFloatArrayRef FloatArrayIn, int Index, int Length);

float GetDispersion(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetDispersion() function calculates the dispersion. The result is returned as a single float value.

float Dispersion = sc.GetDispersion(sc.BaseDataIn[SC_HIGH], 10);
            

sc.GetDOMColumnLeftCoordinate()

sc.GetDOMColumnRightCoordinate()

Type: Function

int GetDOMColumnLeftCoordinate(n_ACSIL::DOMColumnTypeEnum DOMColumn);

int GetDOMColumnRightCoordinate(n_ACSIL::DOMColumnTypeEnum DOMColumn);

The sc.GetDOMColumnLeftCoordinate and sc.GetDOMColumnRightCoordiante functions return the X-axis pixel coordinates for the left and right sides of the given DOMColumn on the current chart. If the requested DOMColumn does not exist on the chart, the functions will return a value of 0.

Valid values for the DOMColumn parameter can be found in the DOMColumnTypeEnum located in the n_ACSIL namespace.>/p>

• DOM_COLUMN_PRICE
• DOM_COLUMN_BUY_ORDER
• DOM_COLUMN_SELL_ORDER
• DOM_COLUMN_BID_SIZE
• DOM_COLUMN_ASK_SIZE
• DOM_COLUMN_COMBINED_BID_ASK_SIZE
• DOM_COLUMN_BID_SIZE_BUY
• DOM_COLUMN_ASK_SIZE_SELL
• DOM_COLUMN_LAST_SIZE
• DOM_COLUMN_CUMULATIVE_LAST_SIZE
• DOM_COLUMN_RECENT_BID_VOLUME
• DOM_COLUMN_RECENT_ASK_VOLUME
• DOM_COLUMN_CURRENT_TRADED_BID_VOLUME
• DOM_COLUMN_CURRENT_TRADED_ASK_VOLUME
• DOM_COLUMN_CURRENT_TRADED_TOTAL_VOLUME
• DOM_COLUMN_BID_MARKET_DEPTH_PULLING_STACKING
• DOM_COLUMN_ASK_MARKET_DEPTH_PULLING_STACKING
• DOM_COLUMN_COMBINED_BID_ASK_MARKET_DEPTH_PULLING_STACKING
• DOM_COLUMN_PROFIT_AND_LOSS
• DOM_COLUMN_SUBGRAPH_LABELS
• DOM_COLUMN_GENERAL_PURPOSE_1
• DOM_COLUMN_GENERAL_PURPOSE_2

One use of these functions is to draw into the general purpose Chart/Trade DOM columns by using the Custom Free Form Drawing operating system API.

int GeneralPurposeColumnLeft = sc.GetDOMColumnLeftCoordinate(n_ACSIL::DOM_COLUMN_GENERAL_PURPOSE_1);

int GeneralPurposeColumnRight = sc.GetDOMColumnRightCoordinate(n_ACSIL::DOM_COLUMN_GENERAL_PURPOSE_1);
            

sc.GetEndingDateTimeForBarIndex()

Type: Function

double GetEndingDateTimeForBarIndex(int BarIndex);

The sc.GetEndingDateTimeForBarIndex function returns the ending Date-Time of a chart bar specified by its bar index. The chart bar index is specified with the BarIndex parameter.

The time returned has microsecond precision and can be assigned to a SCDateTime variable.

This Date-Time is calculated for bars other than at the last bar in the chart. For the last bar in the chart, the ending date time is known precisely if the Global Settings >> Data/Trade Service Settings >> Intraday Data Storage Time Unit is 1 Tick or 1 Second Per Bar .

The chart Session Times are also used in the calculation where necessary. For example, if a chart bar is cut short because it has encountered the end of a specified Intraday session, the end of the session is used as the ending Date-Time for the bar.

sc.GetEndingDateTimeForBarIndexFromChart()

Type: Function

double GetEndingDateTimeForBarIndexFromChart(int ChartNumber, int BarIndex);

The sc.GetEndingDateTimeForBarIndexFromChart function returns the ending Date-Time of a chart bar specified by its bar index. This function can reference any chart in the same Chartbook containing the chart the study function is called from.

The return type is a double which can be directly assigned to a SCDateTime variable.

The chart is specified with the ChartNumber parameter. The chart bar index is specified with the BarIndex parameter.

The returned Date-Time is calculated for bars prior to the last bar in the chart. The calculation is simply the Date-Time of the following bar minus 1 second. However, if the particular time is outside of the Session Times, then it is adjusted to be within the Session Times as explained below.

For the last bar in the chart, the ending Date-Time is known precisely if the Global Settings >> Data/Trade Service Settings >> Intraday Data Storage Time Unit is 1 Tick or 1 Second Per Bar and is the Date-Time of the last trade.

The chart Session Times are also used in the calculation where necessary. For example, if a chart bar is cut short because it has encountered the end of a specified Intraday session, the end of the session is used at the ending Date-Time for the bar.

sc.GetExactMatchForSCDateTime()

Type: Function

GetExactMatchForSCDateTime(int ChartNumber, SCDateTime DateTime);

sc.GetExactMatchForSCDateTime() returns the index into the Base Data arrays of the chart specified by ChartNumber that exactly matches the DateTime. If there is no exact match, this function returns -1.

This function can be used on the sc.BaseData[] arrays for the same chart that your study function is applied to when searching for the Date-Time. To do this, pass sc.ChartNumber for the ChartNumber parameter.

If ChartNumber is given as a negative number, the bar period and other Chart Settings are synchronized between the two charts. If it is positive, this does not occur. For example, if you want to get the index from chart #5, and you want to synchronize the charts, then use -5 for the ChartNumber parameter.

For complete information about the SCDateTime parameter type, refer to SCDateTime.

// Get the index into the Base Data of chart #2
// that exactly matches the DateTime given through the Input 0

// Get the DateTime from Input 0
SCDateTime DateTime = sc.Input[0].GetDateTime();

int Chart2Index = sc.GetExactMatchForSCDateTime(2, DateTime);

if(Chart2Index != -1)
{
    //Your Code
}
            

sc.GetFirstIndexForDate()

Type: Function

int GetFirstIndexForDate(int ChartNumber, int TradingDayDate);

The sc.GetFirstIndexForDate() function returns the first array index into the sc.BaseDateTimeIn[][] array for the specified ChartNumber where the given TradingDayDate first occurs.

For an understanding of Trading day dates, refer to Understanding Trading Day Dates Based on Session Times.

If there are no bars in the array matching the requested TradingDayDate, then the index of the first array index after the requested TradingDayDate is returned.

The TradingDayDate parameter is a SCDateTime type that contains the date only. If it contains a time, the time part will be ignored.

FirstIndexOfReferenceDay = sc.GetFirstIndexForDate(sc.ChartNumber, ReferenceDay);

if (sc.GetTradingDayDate(sc.BaseDateTimeIn[FirstIndexOfReferenceDay]) == ReferenceDay)
    --InNumberOfDaysBack;
            

sc.GetFirstNearestIndexForTradingDayDate()

Type: Function

int sc.GetFirstNearestIndexForTradingDayDate(int ChartNumber, int TradingDayDate);

The sc.GetFirstNearestIndexForTradingDayDate() function returns the first array index into the sc.BaseDateTimeIn[][] array for the specified ChartNumber where the given TradingDayDate first occurs.

For an understanding of Trading day dates, refer to Understanding Trading Day Dates Based on Session Times.

If there are no bars in the array matching the requested TradingDayDate, then the index with the date-time that is nearest to the given TradingDayDate is returned.

The TradingDayDate parameter is a SCDateTime type that contains the date only. If it contains a time, the time part will be ignored.

sc.GetFlatToFlatTradeListEntry()

Refer to the sc.GetFlatToFlatTradeListEntry() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetFlatToFlatTradeListSize()

Refer to the sc.GetFlatToFlatTradeListSize() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetGraphicsSetting()

Type: Function

int32_t GetGraphicsSetting(const int32_t ChartNumber, const n_ACSIL::GraphicsSettingsEnum GraphicsSetting, uint32_t& r_Color, uint32_t& r_LineWidth, SubgraphLineStyles& r_LineStyle);

The sc.GetGraphicsSetting function .

sc.GetGraphVisibleHighAndLow()

Type: Function

void GetGraphVisibleHighAndLow(double& High, double& Low);

The sc.GetGraphVisibleHighAndLow function determines the highest and lowest price values for the scale of the study instance from which this function is called at the time of the function call and puts that information into the referenced variables.

sc.GetHideChartDrawingsFromOtherCharts()

Type: Function

int GetHideChartDrawingsFromOtherCharts(const int ChartNumber);

The sc.GetHideChartDrawingsFromOtherCharts function .

sc.GetHighest()

Type: Intermediate Study Calculation Function

float GetHighest(SCFloatArrayRef FloatArrayIn, int Index, int Length);

float GetHighest(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetHighest() function returns the highest value over the specified Length in the FloatArrayIn array.

//Get the highest high from the base graph over the last 20 bars
float Highest = sc.GetHighest(sc.BaseDataIn[SC_HIGH], 20);

//Get the highest value from sc.Subgraph[0] over the last 20 bars
Highest = sc.GetHighest(sc.Subgraph[0], 20);
            

sc.GetHighestChartNumberUsedInChartBook()

Type: Function

int GetHighestChartNumberUsedInChartBook();

The sc.GetHighestChartNumberUsedInChartBook function returns the highest Chart Number used in the Chartbook the chart the study function is applied to, belongs to.

Each chart has a number which is displayed on its title bar. This is its Chart Number for identification purposes.

sc.GetIndexOfHighestValue()

Type: Function

float GetIndexOfHighestValue(SCFloatArrayRef FloatArrayIn, int Index, int Length);

float GetIndexOfHighestValue(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetIndexOfHighestValue() function returns the bar index of the highest value over the specified Length in the FloatArrayIn array.

sc.GetIndexOfLowestValue()

Type: Function

float GetIndexOfLowestValue(SCFloatArrayRef FloatArrayIn, int Index, int Length);

float GetIndexOfLowestValue(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetIndexOfLowestValue() function returns the bar index of the lowest value over the specified Length in the FloatArrayIn array.

sc.GetIslandReversal()

Type: Intermediate Study Calculation Function

int GetIslandReversal(SCBaseDataRef BaseDataIn, int Index);

int GetIslandReversal(SCBaseDataRef BaseDataIn); Auto-looping only.

The sc.GetIslandReversal() function determines an Island Reversal. This function returns one of the following values:
0 = No Gap.
1 = Gap Up.
-1 = Gap Down.

int IslandReversal = sc.GetIslandReversal(sc.BaseDataIn);
            

sc.GetLastFileErrorCode()

Type: Function

int GetLastFileErrorCode(const int FileHandle);

The sc.GetLastFileErrorCode function returns the last error code associated with the FileHandle parameter which is obtained by sc.OpenFile().

The returned code is the standard operating system error code.

Additionally the following error codes are defined:

• ERROR_MISSING_PATH_AND_FILE_NAME = 0x20000001
• ERROR_NO_BUFFER_GIVEN_INPUT = 0x20000002
• ERROR_NO_BUFFER_GIVEN_OUTPUT = 0x20000003
• ERROR_NOT_ENOUGH_DATA_FOR_VALUE = 0x20000004
• ERROR_AT_END_OF_FILE = 0x20000005
• ERROR_END_OF_LINE_NOT_FOUND = 0x20000006
• ERROR_FILE_NOT_OPEN = 0x20000007
• ERROR_ALLOCATING_MEMORY = 0x20000008

sc.GetLastFileErrorMessage()

Type: Function

SCString GetLastFileErrorMessage(const int FileHandle);

The sc.GetLastFileErrorMessage() function returns the last error message, if there is one, associated with the File Handle defined by FileHandle.

If there is no error message, an empty string is returned.

sc.GetLastPriceForTrading()

Type: Function

double GetLastPriceForTrading();

GetLastPriceForTrading returns the most current last trade price for the Symbol of the chart either from the connected data feed or from the last bar in the chart if the data feed price is 0 meaning it is not available.

This function also works during a chart replay.

double LastPrice = sc.GetLastPriceForTrading();       
            

sc.GetLatestBarCountdownAsInteger()

Type: Function

int scGetLatestBarCountdownAsInteger();

The sc.GetLatestBarCountdownAsInteger() function returns the remaining time/value for the most recent chart bar until it is considered finished, as an integer value.

int CountdownValue = sc.GetLatestBarCountdownAsInteger();
RemainingAmountForSubgraphValue = (float)CountdownValue;

Tool.Text.Format("%d",CountdownValue);
            

sc.GetLineNumberOfSelectedUserDrawnDrawing

Refer to the sc.GetLineNumberOfSelectedUserDrawnDrawing() section on the Using Drawing Tools From an Advanced Custom Study page for information on this function.

sc.GetLowest()

Type: Intermediate Study Calculation Function

float GetLowest(SCFloatArrayRef FloatArrayIn, int Index, int Length);

float GetLowest(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetLowest() function returns the lowest value over the specified Length in the FloatArrayIn array.

float Lowest = sc.GetLowest(sc.BaseDataIn[SC_LOW], 20);

Lowest = sc.GetLowest(sc.Subgraph[0], 20);
            

sc.GetMainGraphVisibleHighAndLow()

Type: Function

GetMainGraphVisibleHighAndLow (float& High, float& Low);

sc.GetMainGraphVisibleHighAndLow will get the highest High and lowest Low for the visible bars of the main price graph in the chart.

float High, Low;

sc.GetMainGraphVisibleHighAndLow(High,Low);
            

sc.GetMarketDepthBars()

Type: Function

c_ACSILDepthBars* GetMarketDepthBars();

sc.GetMarketDepthBars returns access to the historical market depth bars that are on the same chart that your custom study is applied to. The return value is a pointer to a c_ACSILDepthBars object, which has various functions for retrieving data from the historical market depth bars. See the c_ACSILDepthBars class for details.

sc.GetMarketDepthBars should never return a null pointer, but it is still good practice to check to make sure the returned pointer is not null before using it.

sc.GetMarketDepthBarsFromChart()

Type: Function

c_ACSILDepthBars* GetMarketDepthBarsFromChart(int ChartNumber);

sc.GetDepthBarFromChart returns access to the historical market depth bar from the chart that matches the given ChartNumber parameter. The return value is a pointer to a c_ACSILDepthBars object, which has various functions for retrieving data from the historical market depth bars. See the c_ACSILDepthBars class for details.

sc.GetDepthBarFromChart should never return a null pointer, but it is still good practice to check to make sure the returned pointer is not null before using it.

sc.GetMaximumMarketDepthLevels

Type: Function

int GetMaximumMarketDepthLevels();

The sc.GetMaximumMarketDepthLevels function returns the maximum number of available market depth levels for the symbol of the chart. This will be the maximum for both the bid and ask sides, whichever is greater.

sc.GetNearestMatchForDateTimeIndex()

Type: Function

int GetNearestMatchForDateTimeIndex(int ChartNumber, int DateTimeIndex);

sc.GetNearestMatchForDateTimeIndex() returns the index into the Base Data arrays of the chart specified by ChartNumber with the Date-Time closest to the Date-Time at the index specified by DateTimeIndex in the chart your study is applied to. If the Date-Time at DateTimeIndex is before any Date-Time in the specified chart, then the index of the first element is given (0). If the Date-Time at DateTimeIndex is after any Date-Time in the specified chart, then the index of the last element is given (sc.ArraySize - 1).

This function can be used on the sc.BaseData[] arrays for the same chart that your study function is applied to when searching for the Date-Time. To do this, pass sc.ChartNumber for the ChartNumber parameter.

If ChartNumber is given as a negative number, the bar period and other Chart Settings are synchronized between the two charts. If it is positive, this does not occur. For example, if you want to get the index from chart #5, and you want to synchronize the charts, then use -5 for the ChartNumber parameter.

// Get the index in the Base Data arrays for chart #2 that
// has the nearest matching Date-Time to the Date-Time
// at the current index being calculated for the chart that
// this study is on.

int Chart2Index = sc.GetNearestMatchForDateTimeIndex(2, sc.Index);

SCGraphData ReferenceArrays;
sc.GetChartBaseData(2, ReferenceArrays);

if (ReferenceArrays[SC_HIGH].GetArraySize() < 1)//Array is empty, nothing to do.

   return;

//Get the corresponding High 
float High = ReferenceArrays[SC_HIGH][Chart2Index];
            

sc.GetNearestMatchForSCDateTime()

Type: Function

int GetNearestMatchForSCDateTime(int ChartNumber, SCDateTime DateTime);

sc.GetNearestMatchForSCDateTime() returns the index into the Base Data arrays of the chart specified by the ChartNumber parameter with the Date-Time closest to the DateTime parameter.

If the specified DateTime is before any Date-Time in the specified chart, then the index of the first element is given (0). If DateTime is after any Date-Time in the specified chart, then the index of the last element is given (sc.ArraySize - 1).

The extended array elements of the chart in the forward projection area of the chart are not included in the search.

This function can be used on the sc.BaseData[] arrays for the same chart that your study function is applied to when searching for the Date-Time. To do this, pass sc.ChartNumber for the ChartNumber parameter.

If ChartNumber is given as a negative number, the bar period and other Chart Settings are synchronized between the two charts. If it is positive, this does not occur. For example, if you want to get the index from chart #5, and you want to synchronize the charts, then use -5 for the ChartNumber parameter.

For complete information about the SCDateTime parameter type, refer to SCDateTime.

// Get the index in the Base Data arrays for chart #2 that
// has the nearest matching Date-Time to the given DateTime.

SCDateTime DateTime = sc.BaseDateTimeIn[sc.Index];

int Chart2Index = sc.GetNearestMatchForSCDateTime(2, DateTime);

SCGraphData ReferenceArrays;
sc.GetChartBaseData(2, ReferenceArrays);

if (ReferenceArrays[SC_HIGH].GetArraySize() < 1)//Array is empty, nothing to do.

   return;

//Get the corresponding High 
float High = ReferenceArrays[SC_HIGH][Chart2Index];
            

sc.GetNearestMatchForSCDateTimeExtended()

Type: Function

int GetNearestMatchForSCDateTimeExtended(int ChartNumber, const SCDateTime& DateTime);

The sc.GetNearestMatchforSCDateTimeExtended() function is identical to the sc.GetNearestMatchForSCDateTime() function, except that it also searches the extended array elements of the chart in the forward projection area.

For complete documentation for this function, refer to sc.GetNearestMatchForSCDateTime(). The only other difference has been explained here.

For a complete example to use this function, refer to the scsf_VerticalDateTimeLine function in the /ACS_Source/studies2.cpp file in the folder Sierra Chart is installed to.

sc.GetNearestStopOrder()

Refer to the sc.GetNearestStopOrder() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetNearestTargetOrder()

Refer to the sc.GetNearestTargetOrder() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetNumberOfBaseGraphArrays()

Type: Function

int GetNumberOfBaseGraphArrays();

The sc.GetNumberOfBaseGraphArrays() function gets the number of arrays allocated in sc.BaseData[].

int NumberOfBaseDataArrays = sc.GetNumberOfBaseGraphArrays();
            

sc.GetNumberOfDataFeedSymbolsTracked()

Type: Function

int GetNumberOfDataFeedSymbolsTracked();

The sc.GetNumberOfDataFeedSymbolsTracked() function returns the number of symbols Sierra Chart is currently tracking through the connected data feed. This function has no parameters.

For additional information, refer to Status Bar.

sc.GetNumPriceLevelsForStudyProfile()

Type: Function

int GetNumPriceLevelsForStudyProfile(int StudyID, int ProfileIndex);

The sc.GetNumPriceLevelsForStudyProfile function is to be used with the sc.GetVolumeAtPriceDataForStudyProfile function. It is used to return the number of price levels contained within a Volume Profile.

These Volume Profiles are from a TPO Profile Chart or Volume by Price study on the chart.

The function returns the number of price levels within the specified Volume Profile.

sc.GetNumStudyProfiles()

Type: Function

int GetNumStudyProfiles(int StudyID);

sc.GetNumStudyProfiles will get the number of TPO Profiles or Volume Profiles for the TPO Profile Chart and the Volume by Price study respectively in the instance of the study specified by the StudyID parameter.

            int NumProfiles = sc.GetNumStudyProfiles(1);
            

sc.GetOHLCForDate()

Type: Function

GetOHLCForDate(double Date, float& Open, float& High, float& Low, float& Close);

The sc.GetOHLCForDate() function returns the Open, High, Low and Close of the period of time in an Intraday chart that is for the date specified by the Date parameter.

The Period of time is 1 Day. The starting and ending times are controlled by the Session Times settings in Chart >> Chart Settings for the Chart.

The end of the day is the time set by the End Time. The day includes the 24 hours prior to that time.

For efficiency, this function should only be called once a day while iterating through the chart bars in the study function. The values returned should be saved for the next iteration until a new day is encountered according to the Session Times.

float Open;
float High;

float Low;
float Close;

sc.GetOHLCForDate(sc.BaseDateTimeIn[sc.ArraySize-1], Open, High, Low, Close);

SCString Message;
Message.Format("O: %f, H: %f, L: %f , C: %f",Open,High,Low,Close);

sc.AddMessageToLog(Message,1);
            

sc.GetOHLCOfTimePeriod()

Type: Function

int GetOHLCOfTimePeriod(SCDateTime StartDateTime, SCDateTime EndDateTime, float& Open, float& High, float& Low, float& Close, float& NextOpen);

sc.GetOHLCOfTimePeriod() returns the Open, High, Low, Close and NextOpen of the period of time in an Intraday chart specified by the StartDateTime and EndDateTime parameters.

// In this example these are not set to anything. You will need to
// set them to the appropriate starting DateTime and ending DateTime
SCDateTime dt_StartTime, dt_EndTime;

float Open;
float High;
float Low;
float Close;

float NextOpen;

sc.GetOHLCOfTimePeriod( dt_StartTime, dt_EndTime, Open, High, Low, Close, NextOpen) ; 
            

sc.GetOpenHighLowCloseVolumeForDate()

int GetOpenHighLowCloseVolumeForDate(double Date, float& r_Open, float& r_High, float& r_Low, float& r_Close, float& r_Volume);

The sc.GetOpenHighLowCloseVolumeForDate function returns the Open, High, Low, Close and Volume values for the specified trading day Date.

This function is affected by the chart Session Times when determining the specific date-time range for these values.

This function returns 1 if it is successful or 0 if an error was encountered or the date is not found.

sc.GetOrderByIndex()

Refer to the sc.GetOrderByIndex() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetOrderByOrderID()

Refer to the sc.GetOrderByOrderID() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetOrderFillArraySize()

Refer to the sc.GetOrderFillArraySize() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetOrderFillEntry()

Refer to the sc.GetOrderFillEntry() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetOrderForSymbolAndAccountByIndex()

Refer to the sc.GetOrderForSymbolAndAccountByIndex() section on the Automated Trading From an Advanced Custom Study page for information on this function.

sc.GetParentOrderIDFromAttachedOrderID()

Type: Function

void GetParentOrderIDFromAttachedOrderID(int AttachedOrderInternalOrderID);

The sc.GetParentOrderIDFromAttachedOrderID function is to return the parent Internal Order ID for the given Attached Order Internal Order ID.

For information about Internal Order IDs, refer to the ACSIL Trading page. These Internal Order IDs can be obtained when submitting an order.

sc.GetPersistentDouble()

sc.SetPersistentDouble()

double& GetPersistentDouble(int Key);

void SetPersistentDouble(int Key, double Value);

Refer to the common Persistent Variable Functions documentation.

sc.GetPersistentDoubleFromChartStudy()

sc.SetPersistentDoubleForChartStudy()

double& GetPersistentDoubleFromChartStudy(int ChartNumber, int StudyID, int Key);

void SetPersistentDoubleForChartStudy(int ChartNumber, int StudyID, int Key, double Value);

Refer to the common Chart Study Persistent Variable Functions documentation.

sc.GetPersistentFloat()

sc.SetPersistentFloat()

float& GetPersistentFloat(int Key);

void SetPersistentFloat(int Key, float Value);

Refer to the common Persistent Variable Functions documentation.

sc.GetPersistentFloatFromChartStudy()

sc.SetPersistentFloatForChartStudy()

float& GetPersistentFloatFromChartStudy(int ChartNumber, int StudyID, int Key);

void SetPersistentFloatForChartStudy(int ChartNumber, int StudyID, int Key, float Value);

Refer to the common Chart Study Persistent Variable Functions documentation.

sc.GetPersistentInt()

sc.SetPersistentInt()

int& GetPersistentInt(int Key);

void SetPersistentInt(int Key, int Value);

Refer to the common Persistent Variable Functions documentation.

sc.GetPersistentIntFromChartStudy()

sc.SetPersistentIntForChartStudy()

int& GetPersistentIntFromChartStudy(int ChartNumber, int StudyID, int Key);

void SetPersistentIntForChartStudy(int ChartNumber, int StudyID, int Key, int Value);

Refer to the common Chart Study Persistent Variable Functions documentation.

sc.GetPersistentInt64()

sc.SetPersistentInt64()

__int64& GetPersistentInt64(int Key);

void SetPersistentInt64(int Key, __int64 Value);

Refer to the common Persistent Variable Functions documentation.

sc.GetPersistentInt64FromChartStudy()

sc.SetPersistentInt64ForChartStudy()

__int64& GetPersistentInt64FromChartStudy(int ChartNumber, int StudyID, int Key);

void SetPersistentInt64ForChartStudy(int ChartNumber, int StudyID, int Key, __int64 Value);

Refer to the common Chart Study Persistent Variable Functions documentation.

sc.GetPersistentPointer()

sc.SetPersistentPointer()

void*& GetPersistentPointer(int Key);

void SetPersistentPointer(int Key, void* Value);

Refer to the common Persistent Variable Functions documentation.

References to Persistent Variables

You can use references to give names to the persistent variables by defining new variables that refer to the persistent variables. This is helpful because it makes your code easier to understand and work with. This really is the usual way in which persistent variables should be worked with since the sc.GetPersistent* functions always return a reference. Refer to the code example below for how to do this.

// Use persistent variables to remember attached order IDs so they can be modified or canceled. 
int& Target1OrderID = sc.GetPersistentInt(1);
int& Stop1OrderID = sc.GetPersistentInt(2);

sc.SetPersistentFloat(1, 25.4f);

int& r_MenuID = sc.GetPersistentIntFast(1);
            

Resetting Persistent Variables Example

Usually you will want to reset persistent variables back to default values when a study is recalculated. This does not happen automatically and must be specifically programmed when there is an indication a study is being fully recalculated. This can be done by using the following code below.

if (sc.IsFullRecalculation && sc.Index == 0)//This indicates a study is being recalculated.
{

    // When there is a full recalculation of the study,
    // reset the persistent variables we are using
    sc.GetPersistentInt(0) = 0;
    sc.GetPersistentInt(1) = 0;
    sc.GetPersistentInt(2) = 0;
    sc.GetPersistentInt(3) = 0;
}
            

References to SCDateTime Variables

SCDateTime and SCDateTimeMS variables internally are of the same type. sc.GetPersistentSCDateTime can be used to obtain a persistent variable for either of these types.

Parameters

• BarIndex: The Index of the chart bar for which the Point of Control and Value Areas High and Low are requested.
• r_PointOfControl: The returned price level of the Point of Control for the given BarIndex.
• r_ValueAreaHigh: The returned price level of the Value Area High for the ValueAreaPercentage.
• r_ValueAreaLow: The returned price level of the Value Area Low for the ValueAreaPercentage.
• ValueAreaPercentage: The Value Area Percentage to be used for the Value Area Calculations. This number is to be entered as a percentage value (example 80.5).

sc.GetPointOfControlPriceVolumeForBar()

Type: Function

void GetPointOfControlPriceVolumeForBar(int BarIndex, s_VolumeAtPriceV2& VolumeAtPrice);

The sc.GetPointOfControlPriceVolumeForBar function fills out a s_VolumeAtPriceV2 structure object passed to the function for the Point of Control price level based on volume for the chart bar at the index specified by BarIndex.

It is necessary to set sc.MaintainVolumeAtPriceData = 1; in the sc.SetDefaults code block at the top of the function in order to have the volume at price data maintained so that this function returns valid data.

s_VolumeAtPriceV2 VolumeAtPrice;
sc.GetPointOfControlPriceVolumeForBar(sc.Index, VolumeAtPrice);           
            

sc.GetProfitManagementStringForTradeAccount()

Type: Function

void GetProfitManagementStringForTradeAccount(SCString& r_TextString);

The sc.GetProfitManagementStringForTradeAccount function returns the Profit/Loss Status text string for the Trade Account the chart is set to, from the Global Profit/Loss Management, into the variable r_TextString.

For an example of how this function is used, refer to the study function scsf_TradingProfitManagementStatus in the /ACS_Source/studies5.cpp file in the Sierra_ Chart installation folder.

sc.GetRealTimeSymbol()

Type: Function

SCString& GetRealTimeSymbol();

sc.GetRecentAskVolumeAtPrice() / sc.GetRecentBidVolumeAtPrice()

Type: Function

unsigned int GetRecentAskVolumeAtPrice(float Price);

unsigned int GetRecentBidVolumeAtPrice(float Price);

The sc.GetRecentAskVolumeAtPrice and sc.GetRecentBidVolumeAtPrice functions return the recent Ask or Bid volume respectively, for the given Price parameter. This is one of the market data columns on the Chart/Trade DOM. This data is maintained from the real-time market data and also during a chart replay.

For a description of this particular market data column, refer to Recent Bid Volume/Recent Ask Volume.

For these functions to return a volume value, it is necessary Trade >> Trading Chart DOM On is enabled for one of the charts for the Symbol. And the Recent Bid/Ask Volume columns need to be added. Refer to Customize Trade/Chart DOM Columns and Descriptions for instructions.

 unsigned int RecentAskVolume = sc.GetRecentAskVolumeAtPrice(sc.LastTradePrice);
            

sc.GetReplayHasFinishedStatus()

Type: Function

int GetReplayHasFinishedStatus();

When a Chart Replay has finished in a chart, at that time the study function will be called one more time and you can check that it has finished, by calling the sc.GetReplayHasFinishedStatus function.

The return value of this function will be 1, if the replay has just finished. If it is 0, then the replay has not finished or the finished state has been cleared. A return value of 1 is only going to be provided for one chart calculation.

sc.GetReplayStatusFromChart()

Type: Function

int32_t GetReplayStatusFromChart(int ChartNumber);

The sc.GetReplayStatusFromChart function returns one of the following values indicating the replay status for the specified Chart Number.

• REPLAY_STOPPED = 0
• REPLAY_RUNNING = 1
• REPLAY_PAUSED = 2

sc.GetSessionTimesFromChart()

Type: Function

int GetSessionTimesFromChart(const int ChartNumber, n_ACSIL::s_ChartSessionTimes& r_ChartSessionTimes);

The sc.GetSessionTimesFromChart() function sets the chart session times in r_ChartSessionTimes for the chart defined by ChartNumber.

sc.GetSheetCellAsDouble()

Type: Function

int GetSheetCellAsDouble(void* SheetHandle, const int Column, const int Row, double& r_CellValue);

The sc.GetSheetCellAsDouble() function places the value of the requested Spreadsheet Sheet Cell in the double variable r_CellValue.

If the cell does not contain a value, then this function returns a value of 0. Otherwise, it returns a value of 1.

Also refer to the following functions: sc.SetSheetCellAsDouble(), sc.GetSheetCellAsString(), sc.SetSheetCellAsString(), sc.GetSpreadsheetSheetHandleByName().

    const char* SheetCollectionName = "ACSILInteractionExample";

    const char* SheetName = "Sheet1";

    void* SheetHandle = sc.GetSpreadsheetSheetHandleByName(SheetCollectionName, SheetName, false);

    // Get the result from cell B4. Column and row indexes are zero-based.
    double CellValue = 0.0;
    sc.GetSheetCellAsDouble(SheetHandle, 1, 3, CellValue);
            

sc.GetSheetCellAsString()

Type: Function

int GetSheetCellAsString(void* SheetHandle, const int Column, const int Row, SCString& r_CellString);

The sc.GetSheetCellAsString() function places the value of the requested Spreadsheet Sheet Cell in the SCString variable r_CellValue.

If the cell does not contain a value, then this function returns a value of 0. Otherwise, it returns a value of 1.

Also refer to the following functions: sc.GetSheetCellAsDouble(), sc.SetSheetCellAsDouble(), sc.SetSheetCellAsString(), sc.GetSpreadsheetSheetHandleByName().

const char* SheetCollectionName = "ACSILInteractionExample";

const char* SheetName = "Sheet1";

void* SheetHandle = sc.GetSpreadsheetSheetHandleByName(SheetCollectionName, SheetName, false);

// Get the text from cell B6, if it exists, and add it to the message log.
SCString CellString;
if (sc.GetSheetCellAsString(SheetHandle, 1, 5, CellString))
    sc.AddMessageToLog(CellString, 0);
            

sc.GetSpreadsheetSheetHandleByName()

Type: Function

void* GetSpreadsheetSheetHandleByName(const char* SheetCollectionName, const char* SheetName, const int CreateSheetIfNotExist);

The GetSpreadsheetSheetHandleByName() function returns a pointer to the Spreadsheet Handle for the given SheetCollectionName and SheetName.

Also refer to the following functions: sc.GetSheetCellAsDouble(), sc.SetSheetCellAsDouble(), sc.GetSheetCellAsString(), sc.SetSheetCellAsString().

void* SheetHandle = sc.GetSpreadsheetSheetHandleByName(SheetCollectionName, SheetName, false);
            

sc.GetStandardError()

Type: Intermediate Study Calculation Function

double GetStandardError(SCFloatArrayRef FloatArrayIn, int Index, int Length);

double GetStandardError(SCFloatArrayRef FloatArrayIn, int Length); Auto-looping only.

The sc.GetStandardError() function calculates the Standard Error. The result is returned as a double precision float value.

double StandardErrorValue = sc.GetStandardError(sc.BaseDataIn[SC_LAST], Length.GetInt());
            

sc.GetStartDateTimeForTradingDate()

Type: Function

double GetStartDateTimeForTradingDate(int TradingDate);

The sc.GetStartDateTimeForTradingDate() function returns a Date-Time as a double which can be assigned to a SCDateTime variable, which is the starting Date and Time of the trading session that the given TradingDate is within. TradingDate is considered the date of the trading day independent of the actual date of trading. For example, trading during the evening session the day before next days Day session will have a TradingDate 1 day ahead of the actual date of trading. Therefore, if a trading session spans over midnight according to the Session Times of the chart the study is applied to, then the Date of the returned Date-Time will always be one less than the given TradingDate.

SCDateTime TradingDate;
SCDateTime SessionStartDateTime = sc.GetStartDateTimeForTradingDate(TradingDate);
            

sc.GetStartOfPeriodForDateTime()

Type: Function

SCDateTime GetStartOfPeriodForDateTime(SCDateTime DateTime, unsigned int TimePeriodType, int TimePeriodLength, int PeriodOffset);

The sc.GetStartOfPeriodForDateTime() function gets the beginning of a time period of a length specified by the TimePeriodType and TimePeriodLength parameters, for a given Date-Time.

The start of a time period will always be aligned to the session Start Time in the case of Intraday charts. For periods based on more than one day, the starting reference point will be 1950-1-1. For periods based on weeks, the start will be either Sunday or Monday depending upon the setting of Global Settings >> General Settings >> General >> Data >> Use Monday as Start of Week instead of Sunday. For months, the start will be the first day of the month. For years, the start will be January 1.

The specified time length, will organize time into blocks of the specified length. For example, if the specified time length is 30 minutes, time will be organized this way, assuming the Session Times in Chart >> Chart Setting use a Start Time that begins at the beginning of an hour: |9:30--------------|10:00--------------|10:30--------------. Given a DateTime with a time of 10:07, this function will return 10:00 and the Date of DateTime, since it falls within that section. The return type is an SCDateTime.

sc.GetStudyArray()

Type: Function

GetStudyArray(int StudyNumber, int StudySubgraphNumber, SCFloatArrayRef SubgraphArray);

It is recommended that you use the sc.GetStudyArrayUsingID function. It is a newer function which replaces this function.

sc.GetStudyArray() works similar to the sc.GetChartArray() function. It gets a sc.Subgraph[].Data array from another study on a chart. This way you can use the data from other studies on the same chart as your Advanced Custom Study function is on. The StudyNumber is 1-based, where 1 refers to the first study on the chart. If you specify 0 for StudyNumber, then this function will refer to the main price graph of the chart your study instance is applied to. The StudySubgraphNumber is 1-based and refers to a Subgraph of the study, where 1 is the first subgraph.

Refer to the scsf_GetStudyArrayExample() function in the studies.cpp file inside the ACS_Source folder inside of the Sierra Chart installation folder for example code to work with this function. When calling this function, it fills in the SubgraphArray parameter. If the function fails to get the requested study array for any reason, SubgraphArray will be empty and indicated by SubgraphArray.GetArraySize() equaling 0.

A reason you would want to access studies on a chart rather than internally calculating them and putting the results into sc.Subgraph[].Data[] or Extra Arrays, is so that you can see the studies on the chart and allow the inputs to be easily adjusted by the user. This saves memory and calculations if the studies that you are working with internally in your study are needed to be viewed on the chart anyway.

You need to set the Calculation Precedence to LOW_PREC_LEVEL, in the sc.SetDefaults code block when using this function. Otherwise, you may get an array that has a size of zero and is empty. By setting the calculation precedence to LOW_PREC_LEVEL, you ensure that your custom study will get calculated after other studies on the chart. This will ensure you get an array filled with up to date values.

if (sc.SetDefaults)
{
    sc.CalculationPrecedence = LOW_PREC_LEVEL;
    return;
}

SCFloatArray SubgraphArray;

// Get the third (3) Subgraph data array from the second (2) study
sc.GetStudyArray(2, 3, SubgraphArray);

if (SubgraphArray.GetArraySize() == 0)
{
    return; // The SubgraphArray may not exist or is empty. Either way we can not do anything with it.
}
            

sc.GetStudyArrayFromChart()

Type: Function

GetStudyArrayFromChart(int ChartNumber, int StudyNumber, int StudySubgraphNumber, SCFloatArrayRef SubgraphArray);

sc.GetStudyArrayFromChart() works identically to the sc.GetStudyArray() function, except that it will also access studies on another chart.

It is recommended to use the sc.GetStudyArrayFromChartUsingID study instead as it references a study by its unique ID, rather than the sc.GetStudyArrayFromChart() function.

If the function is unable to get the subgraph array, the array's size will be zero (For example, SubgraphArray.GetArraySize() == 0).

One reason you may want to access a study from another chart is to use the results of a study which is calculated over a different time period per bar.

SCFloatArray SubgraphArray;

// Get the subgraph number 3 data array from the study number 2 on chart number 1
sc.GetStudyArrayFromChart(1, 2, 3, SubgraphArray);

if (SubgraphArray.GetArraySize() == 0)
    return; // The SubgraphArray may not exist or is empty. Either way we can not do anything with it.
            

sc.GetStudyArrayFromChartUsingID()

Type: Function

void GetStudyArrayFromChartUsingID(const s_ChartStudySubgraphValues& ChartStudySubgraphValues, SCFloatArrayRef SubgraphArray);

The sc.GetStudyArrayFromChartUsingID() function gets a sc.Subgraph[].Data[] array from another study on another chart specified with the ChartStudySubgraphValues parameter. The array is set into the SubgraphArray parameter. This function works with the sc.Input[].GetChartStudySubgraphValues() input function.

Note: if ChartStudySubgraphValues.ChartNumber is negative, the bar period and other Chart Settings are synchronized between the two charts. The relevant Chart Settings for the specified ChartNumber are set to the same settings as the chart your study is applied to. If it is positive, this does not occur. For example, if you want to get the base data from chart #5 and you want to synchronize the charts, then pass -5.

SCInputRef StudySubgraphReference = sc.Input[0];

if (sc.SetDefaults)
{
    StudySubgraphReference.Name = "Study And Subgraph To Display";

    StudySubgraphReference.SetChartStudySubgraphValues(1,1, 0);
    return;
}

SCFloatArray StudyReference;
sc.GetStudyArrayFromChartUsingID(StudySubgraphReference.GetChartStudySubgraphValues(), StudyReference);
            

sc.GetStudyArraysFromChart()

Type: Function

GetStudyArraysFromChart(int ChartNumber, int StudyNumber, SCGraphData& GraphData);

sc.GetStudyArraysFromChart() is for getting all of the Subgraph arrays from a study on another chart or the same chart. A more up-to-date version of this function is the sc.GetStudyArraysFromChartUsingID() function.

One reason you may want to access a study from another chart is to use the results of a study which is calculated over a different time frame per bar.

int ChartNumber = 1;

// Get the study arrays from the first study in the specified chart
SCGraphData StudyData;
sc.GetStudyArraysFromChart(ChartNumber, 1, StudyData);

// Check if we got the data and then get the first subgraph array from the study data

if(StudyData.GetArraySize() == 0)
    return;

SCFloatArrayRef StudyArray = StudyData[0];

if(StudyArray.GetArraySize() == 0)
    return;
            

sc.GetStudyArraysFromChartUsingID()

Type: Function

void GetStudyArraysFromChartUsingID(int ChartNumber, int StudyID, SCGraphData& GraphData);

The sc.GetStudyArraysFromChartUsingID() function gets all of the Subgraph arrays from a study specified by the ChartNumber and the unique StudyID parameters.

The StudyID is the unique study identifier.

This function establishes a reference between the chart containing the study which called this function, and the chart specified by the ChartNumber parameter. When the chart specified by ChartNumber is reloaded or a historical data download completes for it, or it is fully recalculated, then the chart calling this function will be tagged for a full recalculation. In this way, the study making reference to another chart, will always be kept up to date automatically without having to do anything special.

 
// Define a graph data object to get all of the study data
SCGraphData StudyData;

// Get the study data from the specified chart
sc.GetStudyArraysFromChartUsingID(ChartStudyInput.GetChartNumber(), ChartStudyInput.GetStudyID(), StudyData);

//Check if the study has been found.  If it has, GetArraySize() will return the number of Subgraphs in the study.
if(StudyData.GetArraySize() == 0)
return;

// Define a reference to the first subgraph array
SCFloatArrayRef Array1 = StudyData[0];

// Check if array is not empty.
if(Array1.GetArraySize() != 0)
{
    // Get last value in array
    float LastValue = Array1[Array1.GetArraySize() - 1];
}
            

sc.GetStudyDataColorArrayFromChartUsingID()

Type: Function

void GetStudyDataColorArrayFromChartUsingID(int ChartNumber, int StudyID, int SubgraphIndex , SCColorArrayRef DataColorArray);

The sc.GetStudyDataColorArrayFromChartUsingID function is used to get the sc.Subgraph[].DataColor array at the Subgraph index specified by SubgraphIndex for the study specified by the StudyID parameter, in the chart specified by the ChartNumber parameter.

The sc.Subgraph[].DataColor array being returned, must be used by the study Subgraph for it to contain data. Otherwise, it will be empty.

Refer to the example below.

       
//Example for sc.GetStudyDataColorArrayFromChartUsingID
//SCInputRef ChartStudySubgraphInput  = sc.Input[4];
//ChartStudySubgraphInput.SetChartStudySubgraphValues(1, 1, 0);

SCColorArray DataColorArray;
sc.GetStudyDataColorArrayFromChartUsingID(ChartStudySubgraphInput.GetChartNumber(), ChartStudySubgraphInput.GetStudyID(), ChartStudySubgraphInput.GetSubgraphIndex() ,  DataColorArray);

if (DataColorArray.GetArraySize() > 0)//size is nonzero meaning that we have gotten a valid array
{
    //Use the array for something
}
        

sc.GetStudyArrayUsingID()

Type: Function

int GetStudyArrayUsingID(unsigned int StudyID, unsigned int StudySubgraphIndex, SCFloatArrayRef SubgraphArray);

sc.GetStudyArrayUsingID() gets the specified sc.Subgraph[].Data array from a study using the study's unique identifier. These are studies that are on the same chart that your custom study is applied to.

If the study you are referencing is moved up or down in the list of Studies to Graph in the Chart Studies window for the chart, the reference still stays valid.

This function works with the sc.Input functions sc.Input[].SetStudyID() or sc.Input[].SetStudySubgraphValues and the related functions for getting the study ID and the study Subgraph values.

StudySubgraphIndex parameter: This is a 0 based index indicating which Subgraph to get from the study specified by StudyID. These indexes directly correspond to the Subgraphs listed in the Subgraphs tab of the Study Settings window for the study. Although this is zero-based and the Subgraphs are 1-based as they are listed. For example, Subgraph 1 (SG1) in the Study Settings window will have a StudySubgraphIndex of 0.

Set the Calculation Precedence to LOW_PREC_LEVEL, in the sc.SetDefaults code block when using this function.

Otherwise, you may get an array that has a size of zero and is empty. By setting the calculation precedence to LOW_PREC_LEVEL, you ensure that the custom study will get calculated after other studies on the chart. This will ensure the study instance receives an array filled with up to date values.

When using this function or any of the ACSIL functions for getting a study array, it is possible to get the sc.Subgraph.Data[] arrays of a Spreadsheet study on the chart. This will allow you to get any of the formula columns data (K-Z and more depending upon the setting of the Number of Formula Columns input). Additionally, by using the appropriate formulas in the Spreadsheete formula columns, you are able to reference other data on the Spreadsheet by having those formula column formulas reference the particular cells that you need.

Return Value: Returns 1 on success or 0 if the StudyID is not found or the StudySubgraphIndex parameter is outside the valid range of subgraph indexes.

For an example, refer to the scsf_ReferenceStudyData function in the /ACS_Source/studies8.cpp file or to the scsf_StudySubgraphsDifference function in the /ACS_Source/studies5.cpp file which are located in the Sierra Chart installation folder.

 
if (sc.SetDefaults)
{
    sc.CalculationPrecedence = LOW_PREC_LEVEL;
    
    sc.Input[1].Name = "Study Reference";
    sc.Input[1].SetStudyID(1);
}

SCFloatArray StudyReference;

//Get the first (0) subgraph from the study the user has selected.

if (sc.GetStudyArrayUsingID(sc.Input[1].GetStudyID(), 0, StudyReference) > 0
    && StudyReference.GetArraySize() > 0)
{

    //Copy the study data that we retrieved using GetStudyArrayUsingID, into a subgraph data output array
    sc.Subgraph[0][sc.Index] = StudyReference[sc.Index];
}
            

sc.GetStudyDataStartIndexFromChartUsingID()

Type: Function

int sc.GetStudyDataStartIndexFromChartUsingID(int ChartNumber, unsigned int StudyID);

The sc.GetStudyDataStartIndexFromChartUsingID() function returns the sc.DataStartIndex from the study specified by the StudyID parameter and the chart specified by the ChartNumber parameter.

sc.GetStudyDataStartIndexUsingID()

Type: Function

int GetStudyDataStartIndexUsingID(unsigned int StudyID);

The sc.GetStudyDataStartIndexUsingID() function gets the sc.DataStartIndex value from another study on the same chart that your custom study is applied to, using the study's unique ID. This is for specialised purposes.

SCInputRef StudyReference = sc.Input[0];

sc.DataStartIndex = sc.GetStudyDataStartIndexUsingID(StudyReference.GetStudyID());
            

sc.GetStudyExtraArrayFromChartUsingID()

Type: Function

int GetStudyExtraArrayFromChartUsingID(int ChartNumber, int StudyID, int SubgraphIndex, int ExtraArrayIndex, SCFloatArrayRef ExtraArrayRef);

The sc.GetStudyExtraArrayFromChartUsingID() function is used for getting one of the sc.Subgraph[].Arrays[][] on a sc.Subgraph from another study. This study can also be on another chart.

       
SCFloatArray ExtraArrayFromChart ; 
sc.GetStudyExtraArrayFromChartUsingID(1, 1, 0, 0, ExtraArrayFromChart); 
if (ExtraArrayFromChart.GetArraySize()>0) 
{ 

}
            

sc.GetStudyIDByIndex()

Type: Function

int GetStudyIDByIndex(int ChartNumber, int StudyNumber);

The sc.GetStudyIDByIndex() function returns the unique sc.StudyGraphInstanceID for the study specified by the ChartNumber and the one based StudyNumber parameters. Chart identifying numbers are shown on the top line of the chart after the #. The StudyNumber is the one based index of the study in the Studies to Graph list in the Chart Studies window.

Setting StudyNumber to 0 will refer to the underlying main price graph of the chart.

sc.GetStudyIDByName()

Type: Function

int sc.GetStudyIDByName(int ChartNumber, const char* Name, const int UseShortNameIfSet);

The sc.GetStudyIDByName() function returns the study identifier of the study identified by the Name parameter.

sc.GetStudyInternalIdentifier()

Type: Function

uint32_t sc.GetStudyInternalIdentifier(int ChartNumber, int StudyID, SCString& r_StudyName);

The sc.GetStudyInternalIdentifier() function .

sc.GetStudyLineUntilFutureIntersection()

Type: Function

int GetStudyLineUntilFutureIntersection(int ChartNumber, int StudyID, int BarIndex, int LineIndex, int& LineIDForBar, float &LineValue, int &ExtensionLineChartColumnEndIndex));

The sc.GetStudyLineUntilFutureIntersection function is used to get the details of a line until future intersection from a study which has added one of these lines using the function sc.AddLineUntilFutureIntersection().

Return Value: If the line is found, 1 is returned. If the line is not found, 0 is returned.

sc.scGetNumLinesUntilFutureIntersection()

Type: Function

int GetStudyLineUntilFutureIntersection(int ChartNumber, int StudyID, int Index);

The sc.GetNumLinesUntilFutureIntersection function is used to get the number of lines which have been added to a particular study through the sc.AddLineUntilFutureIntersection function.

Return Value: The number lines. 0 if there are no lines.

sc.GetStudyLineUntilFutureIntersectionByIndex()

Type: Function

int GetStudyLineUntilFutureIntersectionByIndex(int ChartNumber, int StudyID, int Index, int& r_LineIDForBar, int& r_StartIndex, float& r_LineValue, int& r_ExtensionLineChartColumnEndIndex);

The sc.GetStudyLineUntilFutureIntersectionByIndex function is used to get the details of a line until future intersection from a study which has added one of these lines using the function sc.AddLineUntilFutureIntersection.

This function specifies the future intersection line by its zero-based index (Index) in the container where the lines are stored for the study. The upper bound of this parameter will be the value returned by sc.GetNumLinesUntilFutureIntersection -1.

Return Value: If the line is found, 1 is returned. If the line is not found, 0 is returned.

sc.GetStudyName()

Type: Function

SCString GetStudyName(int StudyIndex);

sc.GetStudyName() returns the name of the study at the index StudyIndex. StudyIndex is not the unique study identifier. It is the one based index based on the order of the studies in the Studies to Graph list in the Chart Studies window for the chart.

To get the name of the main price/base graph for the chart use a StudyIndex of 0.

sc.GetStudyNameFromChart()

Type: Function

SCString GetStudyNameFromChart(int ChartNumber, int StudyID);

The sc.GetStudyNameFromChart() function gets the name of the study identified by StudyID from the chart specified by ChartNumber. StudyID can be 0 to get the name of the underlying main graph of the chart.

SCInputRef ChartStudySubgraphReference = sc.Input[4];

int ChartNumber = ChartStudySubgraphReference.GetChartNumber();
int StudyID = ChartStudySubgraphReference.GetStudyID();

SCString StudyName = sc.GetStudyNameFromChart(ChartNumber, StudyID);
            

sc.GetStudyNameUsingID()

Type: Function

SCString GetStudyNameUsingID(unsigned int StudyID);

The sc.GetStudyNameUsingID() function gets the name of a study on the same chart that your custom study is applied to, using the study's unique ID.

SCInputRef StudyReference = sc.Input[3];

SCString StudyName = sc.GetStudyNameUsingID(StudyReference.GetStudyID());

sc.GraphName.Format("Avg of %s", StudyName);
            

sc.GetStudyPeakValleyLine()

Type: Function

int GetStudyPeakValleyLine(int ChartNumber, int StudyID, float& PeakValleyLinePrice, int& PeakValleyType, int& StartIndex, int& PeakValleyExtensionChartColumnEndIndex, int ProfileIndex , int PeakValleyIndex);

The sc.GetStudyPeakValleyLine() function is used for obtaining the details about a Peak or Valley line from a study if the study supports Peak and Valley lines.

Studies that support these Peak and Valley lines are the TPO Profile Chart and the Volume by Price studies. Peak and Valley lines cannot be obtained for a Volume by Price study which uses Visible Bars for the Volume Graph Period Type Input.

Refer to the parameter list below to understand how to use this function.

This function returns 1 if a Peak or Valley line was found. It returns 0 if one was not found.

This function is only properly supported in version 1844 and higher.

For an example to use this function, refer to the scsf_GetStudyPeakValleyLineExample function in the /ACS_Source/studies2.cpp file in the Sierra Chart installation folder.

sc.GetStudyProfileInformation

Type:Function

int GetStudyProfileInformation(const int StudyID, const int ProfileIndex, n_ACSIL::s_StudyProfileInformation& StudyProfileInformation);

This function when called fills out a StudyProfileInformation structure of type n_ACSIL::s_StudyProfileInformation with all of the numerical details of a Volume Profile or TPO profile when using the Volume by Price study or the TPO Profile Chart study, respectively.

The members of the n_ACSIL::s_StudyProfileInformation structure are listed further below.

sc.GetStudyStorageBlockFromChart