Sierra Chart

https://www.sierrachart.com/index.php?page=doc/
Admin
Sierra Chart is a financial markets charting and trading platform that provides tools for analysis...
Tokens:1,101,846
Snippets:15,901
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Relational and Equality Operator Examples

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_Operators.php

Provides examples of relational and equality operators evaluating to true or false.

```cpp
(7 == 5)     // evaluates to false.
(5 > 4)      // evaluates to true.
(3 != 2)     // evaluates to true.

(6 >= 6)     // evaluates to true.
(5 < 5)      // evaluates to false.
```

--------------------------------

### Retrieve Session Start Time

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Gets the trading day start time based on chart settings. Returns a time value.

```cpp
int SessionStartTime();
```

```cpp
int StartTime = sc.SessionStartTime();
```

--------------------------------

### C-like Initialization Example

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

Shows how to declare an integer variable 'a' and initialize it to 0.

```cpp
int a = 0;
```

--------------------------------

### C-like Initialization Syntax

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

Demonstrates the syntax for initializing a variable using the c-like method with an equal sign.

```cpp
type identifier = initial_value;
```

--------------------------------

### Get Trading Day Start DateTime

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Calculates the starting date-time of the trading day for a given bar based on intraday session settings.

```C++
SCDateTime CurrentBarTradingDayStartDateTime = GetTradingDayStartDateTimeOfBar(BaseDateTimeIn[BarIndex]);
SCDateTime CurrentBarTradingDayEndDateTime = CurrentBarTradingDayStartDateTime + 24 * HOURS - 1 * MILLISECONDS;            
```

--------------------------------

### Constructor Initialization Example

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

Demonstrates declaring an integer variable 'a' and initializing it to 0 using constructor initialization.

```cpp
int a (0);
```

--------------------------------

### Get Start Date Time for Trading Date

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Retrieves the starting date and time of the trading session associated with a specific trading date.

```C++
SCDateTime TradingDate;
SCDateTime SessionStartDateTime = sc.GetStartDateTimeForTradingDate(TradingDate);
            
```

--------------------------------

### Get Start of Trading Day Index

Source: https://www.sierrachart.com/index.php?page=doc/ACSILProgrammingConcepts.html

Retrieve the bar index corresponding to the start of the trading day in an intraday chart. This relies on session times and assumes automatic looping.

```ACSIL
//Get	index	of	start	of	trading	day	based	upon	Date-Time	at	current	index.	This	code	assumes	automatic	looping.
SCDateTime	StartDateTime	=	sc.GetTradingDayStartDateTimeOfBar(sc.BaseDateTimeIn[sc.Index]);
int	StartBarIndex	=	sc.GetContainingIndexForSCDateTime(sc.ChartNumber,	StartDateTime);
					

```

--------------------------------

### Constructor Initialization Syntax

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

Illustrates the syntax for initializing a variable using the constructor method with parentheses.

```cpp
type identifier (initial_value);
```

--------------------------------

### Get Start of Trading Day Index

Source: https://www.sierrachart.com/index.php?page=doc%2FACSILProgrammingConcepts.html

This code retrieves the bar index corresponding to the start of the trading day in an Intraday chart, based on session times. Assumes automatic looping.

```ACSIL
//Get	index	of	start	of	trading	day	based	upon	Date-Time	at	current	index.	This	code	assumes	automatic	looping.
SCDateTime	StartDateTime	=	sc.GetTradingDayStartDateTimeOfBar(sc.BaseDateTimeIn[sc.Index]);
int	StartBarIndex	=	sc.GetContainingIndexForSCDateTime(sc.ChartNumber,	StartDateTime);
```

--------------------------------

### String Declaration and Initialization

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

Shows how to include the string header, declare a string variable, initialize it with a literal, and print it to the console.

```cpp
// my first string
#include <iostream>
#include <string>
using namespace std;

int main () {
  string mystring = "This is a string";
  cout << mystring;
  return 0;
}

/* Output
This is a string
*/
```

--------------------------------

### Using sc.StorageBlock for Persistent Data

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Variables_And_Arrays.html

Demonstrates how to use sc.StorageBlock for custom data storage, including defining a structure and accessing its members.

```cpp
// This is the structure of our data that is to be
// stored in the storage block
struct s_PermData
{
    int Number;
    char Text[32];
};

// Here we make a pointer to the storage block as if
// it was a pointer to our structure
s_PermData* PermData;
PermData = (s_PermData*)sc.StorageBlock;

// Here we set data using the members of our structure
// This uses the memory of the storage block
PermData->Number = 10;
strcpy(PermData->Text, "Sample Text");
```

--------------------------------

### Get Calculation Start Index for Study

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Retrieves the starting index for study calculations, typically used when a study depends on another study that updates earlier indices. Requires manual looping implementation.

```cpp
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;   
            
```

--------------------------------

### GetTimeSalesArrayIndexesForBarIndex Usage Example

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Demonstrates retrieving the Time and Sales array indices for the current update start index and logging the result.

```C++
int BeginIndex = 0, EndIndex = 0;
sc.GetTimeSalesArrayIndexesForBarIndex(sc.UpdateStartIndex, BeginIndex, EndIndex);
SCString DebugString;
DebugString.Format("Time and Sales BeginIndex = %d, EndIndex = %d", BeginIndex, EndIndex);
sc.AddMessageToLog(DebugString, 0);
```

--------------------------------

### Dynamic Class Allocation Example (C++)

Source: https://www.sierrachart.com/index.php?page=doc/ACSILProgrammingConcepts.html

Shows how to allocate and free a class instance using C++ new and delete operators for persistent storage. Remember to free memory before DLL unload to prevent exceptions.

```cpp
if (sc.SetDefaults)
{
    // Set the configuration and defaults

    sc.GraphName = "Dynamic Memory Allocation Example (new/delete)";

    sc.AutoLoop = 1;

    return;
}

//Example class
class ClassA
{
public:
    int IntegerVariable;
};

// Do data processing
  ClassA * p_ClassA = (ClassA *)sc.GetPersistentPointer(1);

if(sc.LastCallToFunction)
{
    if(p_ClassA != NULL)
    {
        delete p_ClassA;
        sc.SetPersistentPointer(1, NULL);
    }

    return;
}

if(p_ClassA == NULL)
{
    //Allocate one instance of the class
    p_ClassA = (ClassA *) new ClassA;

    if(p_ClassA != NULL)
        sc.SetPersistentPointer(1, p_ClassA);
    else
        return;
}

int IntegerVariable = p_ClassA->IntegerVariable;

return;
             

```

--------------------------------

### Implement a Complete Custom Study Function

Source: https://www.sierrachart.com/index.php?page=doc%2FAdvancedCustomStudyInterfaceAndLanguage.php

This example demonstrates the standard structure for a study function, including setting defaults and performing data processing.

```cpp
#include "sierrachart.h"
SCDLLName("Custom Study DLL") 

SCSFExport scsf_UniqueFunctionName(SCStudyInterfaceRef sc)
{
	if (sc.SetDefaults)
	{
		// Set the defaults
		sc.GraphName = "My New Study Function";

		sc.Subgraph[0].Name = "Subgraph name";
		sc.Subgraph[0].DrawStyle = DRAWSTYLE_LINE;

		sc.AutoLoop = 1;

		// Enter any additional configuration code here
		return;
	}

	// Perform your data processing here.

	// Multiply the Last price at the current bar being processed, by 10.
	sc.Subgraph[0][sc.Index] = sc.Close[sc.Index] * 10;

	return;
}
            
```

--------------------------------

### Get Bid Market Depth Levels for Symbol

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Example of retrieving the number of available bid market depth levels for a specific symbol.

```cpp
 
int NumberOfLevels = GetBidMarketDepthNumberOfLevelsForSymbol(sc.Symbol);
			
```

--------------------------------

### Check Sierra Chart Version

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Variables_And_Arrays.html

Use the sc.VersionNumber function to get the current Sierra Chart version as a string. This example checks if the version is less than 2100.

```cpp
if (atoi(sc.VersionNumber().GetChars()) < 2100)
{

    //do something
}
```

--------------------------------

### Initialize a new order with Price1

Source: https://www.sierrachart.com/index.php?page=doc%2FACSILTrading.html

Shows the initialization of an s_SCNewOrder structure, including setting the order quantity, type, time in force, and price.

```cpp
float BarLow = sc.Low[sc.Index];            
            
s_SCNewOrder NewOrder;
NewOrder.OrderQuantity = 1;
NewOrder.OrderType = SCT_ORDERTYPE_STOP;
NewOrder.TimeInForce = SCT_TIF_DAY;
NewOrder.Price1 = BarLow;                
```

--------------------------------

### sc.StartChartReplayNew()

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Starts a chart replay using a structured parameter object for more granular control over replay settings.

```APIDOC
## sc.StartChartReplayNew(n_ACSIL::s_ChartReplayParameters& ChartReplayParameters)

### Description
Starts a chart replay for a chart using the provided s_ChartReplayParameters structure. This allows for additional configuration such as skipping empty periods and setting the replay mode.

### Parameters
- **ChartReplayParameters** (n_ACSIL::s_ChartReplayParameters) - Structure containing: Chart Number, ReplaySpeed, StartDateTime, SkipEmptyPeriods, ReplayMode, and ClearExistingTradeSimulationDataForSymbolAndTradeAccount.
```

--------------------------------

### Getting a Range of Rows with OFFSET

Source: https://www.sierrachart.com/index.php?page=doc%2FWorkingWithSpreadsheets.php

Explains how to use the OFFSET formula function to retrieve a range of rows from a study subgraph column, specifying the starting cell, offset, and the number of rows and columns.

```Excel Formula
OFFSET(ID1.SG1@3, 0, 0, 10, 1)
```

--------------------------------

### Initialize and Use s_UseTool Structure

Source: https://www.sierrachart.com/index.php?page=doc%2FACSILDrawingTools.html

Demonstrates the correct way to initialize the s_UseTool structure using Clear() before setting its members and calling sc.UseTool(). This is crucial when reusing the same structure instance for multiple calls.

```cpp
s_UseTool UseTool;
UseTool.Clear();

// Set relevant members of UseTool here...

sc.UseTool(UseTool);

```

--------------------------------

### Accessing Historical Data with Negative Offset

Source: https://www.sierrachart.com/index.php?page=doc%2FStudyChartAlertsAndScanning.php

Use a negative integer within square brackets after a study subgraph identifier to reference data from previous bars. For example, H[-1] gets the High of the previous bar.

```SierraChart Formula
H[-1]
```

```SierraChart Formula
SG1[-3]
```

```SierraChart Formula
ID2.SG1[-4]
```

--------------------------------

### Basic Function Definition and Call

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_Functions.php

Demonstrates how to define a simple function that performs addition and how to call it from the main function. Shows how arguments are passed and a value is returned.

```cpp
// function example
#include <iostream>
using namespace std;

int addition (int a, int b)
{
  int r;
  r=a+b;
  return (r);
}


int main ()
{
  int z;
  z = addition (5,3);
  cout << "The result is " << z;
  return 0;
}

/* Output
The result is 8
*/
```

--------------------------------

### Get Base Data and Study Arrays from Another Chart

Source: https://www.sierrachart.com/index.php?page=doc%2FACSILRefOtherTimeFrames.php

Demonstrates retrieving Base Data arrays and study arrays from another chart. It also shows methods for finding the corresponding index between arrays of two charts. This example uses Study Inputs to specify the Chart Number and Study ID.

```cpp
#include "sierrachart.h"

SCDLLName("studies8")

// Example of how to get Base Data arrays and Study arrays from another chart.
// This study can be used to get the Moving Average study from another chart.
// The other chart can be on a different timeframe, session, or symbol.
//
// The study settings for this study require the following inputs:
// "Chart Number": The chart number of the other chart.
// "Study ID": The ID of the study on the other chart.
//
// For example, if you want to get the Moving Average study from chart 2, and the Moving Average study ID is 1, then set the inputs to:
// "Chart Number": 2
// "Study ID": 1

SCFloatArray scSubgraph_BaseData_Array;
SCFloatArray scSubgraph_StudyData_Array;

int GetChartBaseDataAndStudyArrays(SCStudyInterfaceRef sc)
{
    SCInputRef Input_ChartNumber = sc.Input[0];
    SCInputRef Input_StudyID = sc.Input[1];

    Input_ChartNumber.Name = "Chart Number";
    Input_StudyID.Name = "Study ID";

    if (sc.SetDefaults)
    {
        sc.GraphName = "Get Other Chart Data";
        sc.StudyDescription = "Gets Base Data and Study Arrays from another chart.";

        Input_ChartNumber.SetInt(1);
        Input_StudyID.SetInt(1);

        sc.AutoLoop = 1;

        return; // Return if we are in SetDefaults mode
    }

    // Get the Base Data arrays from the other chart.
    sc.GetChartBaseData(Input_ChartNumber.GetInt(), scSubgraph_BaseData_Array, SC_HIGH);
    sc.GetChartBaseData(Input_ChartNumber.GetInt(), scSubgraph_BaseData_Array, SC_LOW);
    sc.GetChartBaseData(Input_ChartNumber.GetInt(), scSubgraph_BaseData_Array, SC_OPEN);
    sc.GetChartBaseData(Input_ChartNumber.GetInt(), scSubgraph_BaseData_Array, SC_CLOSE);

    // Get the Study arrays from the other chart.
    sc.GetStudyArraysFromChartUsingID(Input_ChartNumber.GetInt(), Input_StudyID.GetInt(), scSubgraph_StudyData_Array);

    // Now you can use the scSubgraph_BaseData_Array and scSubgraph_StudyData_Array arrays.
    // For example, you can plot them or use them in calculations.

    // Example: Plotting the Close price from the other chart.
    sc.Subgraph[0].Name = "Other Chart Close";
    sc.Subgraph[0].DrawStyle = DRAWSTYLE_LINE;
    sc.Subgraph[0].PrimaryColor = RGB(0, 255, 0);
    sc.Subgraph[0].Data = scSubgraph_BaseData_Array;

    // Example: Plotting the Study data from the other chart.
    sc.Subgraph[1].Name = "Other Chart Study Data";
    sc.Subgraph[1].DrawStyle = DRAWSTYLE_LINE;
    sc.Subgraph[1].PrimaryColor = RGB(255, 0, 0);
    sc.Subgraph[1].Data = scSubgraph_StudyData_Array;

    return; // Return after processing
}

```

--------------------------------

### Perform an HTTP POST Request

Source: https://www.sierrachart.com/index.php?page=doc%2FACSIL_Members_Functions.html

Demonstrates how to configure custom HTTP headers and execute a POST request using sc.MakeHTTPPOSTRequest().

```cpp
n_ACSIL::s_HTTPHeader HTTPHeader;
HTTPHeader.Name = "Custom";
HTTPHeader.Value = "Value";

// Make a request to the server.  
// When the request is complete and all of the data has been downloaded,  
// this study function will be called with the file placed into the
// sc.HTTPResponse character string array. 
if (!sc.MakeHTTPPOSTRequest("https://www.sierrachart.com/Test/ACSILPOSTTest.php", "Message=PostData", &HTTPHeader, 1))
{
    sc.AddMessageToLog("Error making HTTP request.", 1);
}            
            
```

--------------------------------

### GetCorrespondingMatch Function Example

Source: https://www.sierrachart.com/index.php?page=doc%2FSpreadsheetFunctions.html

Example usage of the GetCorrespondingMatch function to search a column range.

```spreadsheet
= GetCorrespondingMatch(AA$3:AA$402, 9, 1, 0, 0, AA$3:AA$402, 0)
```

--------------------------------

### Variable Initialization and Operations

Source: https://www.sierrachart.com/index.php?page=doc%2Fcpp_VariablesDataTypes.php

A complete C++ program demonstrating both c-like and constructor initialization for integers, performing basic arithmetic operations, and printing the result.

```cpp
// initialization of variables

#include <iostream>
using namespace std;

int main () {
  int a=5; 						// initial value = 5

  int b(2); 						// initial value = 2
  int result; 						// initial value undetermined

  a = a + 3;
  result = a - b;
  cout << result;

  return 0;
}

/* Output
6
*/
```

--------------------------------

### Standard JSON Encoding Example

Source: https://www.sierrachart.com/index.php?page=doc%2FDTCProtocol.php

Example of a s_MarketDataUpdateTrade message formatted as a standard JSON object.

```json
{"Type":107, "SymbolID":1, "AtBidOrAsk":0, "Price":2058.75, "Volume":12, "DateTime":1456736458}
```

--------------------------------

### Dynamic Memory Allocation Example (C++)

Source: https://www.sierrachart.com/index.php?page=doc/ACSILProgrammingConcepts.html

Demonstrates allocating and freeing a persistent array of doubles within a study instance using sc.AllocateMemory and sc.FreeMemory. Ensure allocations are not made during sc.SetDefaults.

```cpp
SCSFExport scsf_DynamicMemoryAllocationExample(SCStudyInterfaceRef sc)
{
	if (sc.SetDefaults)
	{
		// Set the configuration and defaults

		sc.GraphName = "Dynamic Memory Allocation Example";

		sc.AutoLoop = 1;

		return;
	}


	// Do data processing
	double * p_DoubleArray = (double*)sc.GetPersistentPointer(1);

	if(sc.LastCallToFunction)
	{
		if(p_DoubleArray != NULL)
		{
			sc.FreeMemory( p_DoubleArray);
			sc.SetPersistentPointer(1, NULL);
		}

		return;
	}

	if(p_DoubleArray == NULL)
	{
		//Allocate an array of 1024 doubles.
		p_DoubleArray = (double *) sc.AllocateMemory( 1024 * sizeof(double) );

		if(p_DoubleArray != NULL)
			sc.SetPersistentPointer(1, p_DoubleArray);
		else
			return;
	}

	//assign value to one of the elements
	p_DoubleArray[0] = 100;

	return;
}
     
```
Tokens:
Raw