CustomSymbols.Remove

method · CustomSymbols · cAlgo.API Since 5.3

DesktopCLICloud

Removes a custom symbol.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Definition

C#Python

bool Remove(CustomSymbol customSymbol)

api.CustomSymbols.Remove(customSymbol: CustomSymbol) -> bool

Parameters

Name	C# type	Python type	Description
`customSymbol`	`CustomSymbol`	`CustomSymbol`	Custom symbol

Returns bool — True if remove was successful otherwise False.

Examples

C#Python

var customSymbol = CustomSymbols.Get("MYEURUSD");
if (customSymbol != null)
    Print("Custom symbol removed: {0}", CustomSymbols.Remove(customSymbol));

customSymbol = api.CustomSymbols.Get("MYEURUSD")
if customSymbol is not None:
    api.Print(f"Custom symbol removed: {api.CustomSymbols.Remove(customSymbol)}")