Paths

StockSharp.Configuration

System paths.

Properties

AppName2
public static string AppName2 { get; }
value = Paths.AppName2
AppNameWithVersion
public static string AppNameWithVersion { get; }
value = Paths.AppNameWithVersion

App title with version.

Bot
public static string Bot { get; }
value = Paths.Bot

Bot in Telegram.

BuildVersion
public static string BuildVersion { get; }
value = Paths.BuildVersion

Build info version.

Chat
public static string Chat { get; }
value = Paths.Chat

Chat in Telegram.

Domain
public static string Domain { get; }
value = Paths.Domain

Web site domain.

EntryAssembly
public static Assembly EntryAssembly { get; }
value = Paths.EntryAssembly

Entry assembly.

InstalledVersion
public static string InstalledVersion { get; }
value = Paths.InstalledVersion

Installed version of the product.

Methods

CreateSerializer``1
public static ISerializer<T> CreateSerializer<T>(bool bom)
result = Paths.CreateSerializer(bom)

Create serializer.

bom
Serializer adds UTF8 BOM preamble.

Returns: Serializer.

DeserializeAsync``1
public static ValueTask<T> DeserializeAsync<T>(string filePath, IFileSystem fileSystem, CancellationToken cancellationToken)
result = Paths.DeserializeAsync(filePath, fileSystem, cancellationToken)

Deserialize value from the specified file.

filePath
File path.
fileSystem
File system.
cancellationToken
CancellationToken

Returns: Value.

DeserializeAsync``1
public static ValueTask<T> DeserializeAsync<T>(string filePath, CancellationToken cancellationToken)
result = Paths.DeserializeAsync(filePath, cancellationToken)

Deserialize value from the specified file.

filePath
File path.
cancellationToken
CancellationToken

Returns: Value.

DeserializeFromString``1
public static void DeserializeFromString<T>(T value, string str)
Paths.DeserializeFromString(value, str)

Deserialize state from .

value
Value.
str
String value.
DeserializeOrThrowAsync``1
public static ValueTask<T> DeserializeOrThrowAsync<T>(string filePath, IFileSystem fileSystem, CancellationToken cancellationToken)
result = Paths.DeserializeOrThrowAsync(filePath, fileSystem, cancellationToken)

Deserialize value from the specified file.

filePath
File path.
fileSystem
File system.
cancellationToken
CancellationToken

Returns: Value.

DeserializeOrThrowAsync``1
public static ValueTask<T> DeserializeOrThrowAsync<T>(string filePath, CancellationToken cancellationToken)
result = Paths.DeserializeOrThrowAsync(filePath, cancellationToken)

Deserialize value from the specified file.

filePath
File path.
cancellationToken
CancellationToken

Returns: Value.

DeserializeOrThrow``1
public static T DeserializeOrThrow<T>(string filePath, IFileSystem fileSystem)
result = Paths.DeserializeOrThrow(filePath, fileSystem)

Deserialize value from the specified file.

filePath
File path.
fileSystem
File system.

Returns: Value.

DeserializeOrThrow``1
public static T DeserializeOrThrow<T>(string filePath)
result = Paths.DeserializeOrThrow(filePath)

Deserialize value from the specified file.

filePath
File path.

Returns: Value.

Deserialize``1
public static T Deserialize<T>(string filePath, IFileSystem fileSystem)
result = Paths.Deserialize(filePath, fileSystem)

Deserialize value from the specified file.

filePath
File path.
fileSystem
File system.

Returns: Value.

Deserialize``1
public static T Deserialize<T>(Stream data)
result = Paths.Deserialize(data)

Deserialize value from the serialized data.

data
Serialized data.

Returns: Value.

Deserialize``1
public static T Deserialize<T>(string filePath)
result = Paths.Deserialize(filePath)

Deserialize value from the specified file.

filePath
File path.

Returns: Value.

Deserialize``1
public static T Deserialize<T>(byte[] data)
result = Paths.Deserialize(data)

Deserialize value from the serialized data.

data
Serialized data.

Returns: Value.

EnumerateConfigs
public static IEnumerable<string> EnumerateConfigs(string path, string filter)
result = Paths.EnumerateConfigs(path, filter)

Returns an files with DefaultSettingsExt extension.

path
The relative or absolute path to the directory to search.
filter
The search string to match against the names of files in path.

Returns: Files.

EnumerateConfigs
public static IEnumerable<string> EnumerateConfigs(string path, IFileSystem fileSystem, string filter)
result = Paths.EnumerateConfigs(path, fileSystem, filter)

Returns an files with DefaultSettingsExt extension.

path
The relative or absolute path to the directory to search.
fileSystem
File system.
filter
The search string to match against the names of files in path.

Returns: Files.

GetAppDataPath
public static string GetAppDataPath(string appDataPath, string appName)
result = Paths.GetAppDataPath(appDataPath, appName)

Get AppDataPath.

appDataPath
Relative AppDataPath.
appName
AppName2

Returns: AppDataPath

GetDocUrl
public static string GetDocUrl(string docUrl)
result = Paths.GetDocUrl(docUrl)

To create localized url.

docUrl
Help topic.

Returns: Localized url.

GetFileName
public static string GetFileName(Guid id)
result = Paths.GetFileName(id)

Get file name for the specified id.

id
Identifier.

Returns: File name.

GetFileNameWithoutExtension
public static string GetFileNameWithoutExtension(Guid id, char? by)
result = Paths.GetFileNameWithoutExtension(id, by)

Get file name without extension for the specified id.

id
Identifier.
by
Replacing character.

Returns: File name without extension.

GetHistoryDataPath
public static string GetHistoryDataPath(string startDir)
result = Paths.GetHistoryDataPath(startDir)

Get history data path.

startDir
Directory.

Returns: History data path.

GetLogoUrl
public static string GetLogoUrl()
result = Paths.GetLogoUrl()

Get logo url.

Returns: Logo url.

GetNuGetGlobalPackagesFolder
public static string GetNuGetGlobalPackagesFolder()
result = Paths.GetNuGetGlobalPackagesFolder()

Get NuGet global packages folder path.

Returns: Path to NuGet global packages folder.

GetPageUrl
public static string GetPageUrl(long id, object urlPart)
result = Paths.GetPageUrl(id, urlPart)

Get page url.

id
Page id.
urlPart
Url part (topic id, file name etc.).

Returns: Localized url.

GetWebSiteUrl
public static string GetWebSiteUrl()
result = Paths.GetWebSiteUrl()

Get website url.

Returns: Localized url.

IsConfigExists
public static bool IsConfigExists(string configFile, IFileSystem fileSystem)
result = Paths.IsConfigExists(configFile, fileSystem)

Determines the specified config file exists.

configFile
Config file.
fileSystem
File system.

Returns: Check result.

IsConfigExists
public static bool IsConfigExists(string configFile)
result = Paths.IsConfigExists(configFile)

Determines the specified config file exists.

configFile
Config file.

Returns: Check result.

MakeBackup
public static string MakeBackup(string filePath)
result = Paths.MakeBackup(filePath)

Make the specified with Backup extension.

filePath
File path.

Returns: File path.

MoveToBackup
public static void MoveToBackup(string filePath, IFileSystem fileSystem, string backupFilePath)
Paths.MoveToBackup(filePath, fileSystem, backupFilePath)

Rename the specified file with Backup extension.

filePath
File path.
fileSystem
File system.
backupFilePath
Backup file path.
ResetInstalledVersionCache
public static void ResetInstalledVersionCache()
Paths.ResetInstalledVersionCache()

Reset installed version cache so it would be re-generated next time when it's requested.

SerializeToString``1
public static string SerializeToString<T>(T value, bool bom)
result = Paths.SerializeToString(value, bom)

Serialize state into String value.

value
Value.
bom
Serializer adds UTF8 BOM preamble.

Returns: String value.

Serialize``1
public static void Serialize<T>(T value, string filePath, bool bom)
Paths.Serialize(value, filePath, bom)

Serialize value into the specified file.

value
Value.
filePath
File path.
bom
Add UTF8 BOM preamble.
Serialize``1
public static void Serialize<T>(T value, IFileSystem fileSystem, string filePath, bool bom)
Paths.Serialize(value, fileSystem, filePath, bom)

Serialize value into the specified file.

value
Value.
fileSystem
File system.
filePath
File path.
bom
Add UTF8 BOM preamble.
Serialize``1
public static byte[] Serialize<T>(T value, bool bom)
result = Paths.Serialize(value, bom)

Serialize value into byte array.

value
Value.
bom
Add UTF8 BOM preamble.

Returns: Serialized data.

TryBuildDocUrl
public static string TryBuildDocUrl(string urlPart)
result = Paths.TryBuildDocUrl(urlPart)

Try to build documentation URL.

urlPart
URL part.

Returns: Absolute URL.

TryGetInstalledPath
public static string TryGetInstalledPath(long productId, IFileSystem fileSystem)
result = Paths.TryGetInstalledPath(productId, fileSystem)

Try get installed path by product id.

productId
Identifier.
fileSystem
File system.

Returns: Installed path.

TryGetInstalledVersion
public static string TryGetInstalledVersion(string productInstallPath, IFileSystem fileSystem)
result = Paths.TryGetInstalledVersion(productInstallPath, fileSystem)

Get currently installed version of the product.

productInstallPath
File system path to product installation.
fileSystem
File system.

Returns: Installed version of the product.

Fields

AppDataPath
public static readonly string AppDataPath
value = Paths.AppDataPath

The path to the settings directory.

AppName
public static readonly string AppName
value = Paths.AppName

App title.

Birthday
public static readonly DateTime Birthday
value = Paths.Birthday

Birthday.

CandlePatternsFile
public static readonly string CandlePatternsFile
value = Paths.CandlePatternsFile

The path to the file with candle patterns.

CompanyPath
public static readonly string CompanyPath
value = Paths.CompanyPath

The path to directory with all applications.

CompilerCacheDir
public static readonly string CompilerCacheDir
value = Paths.CompilerCacheDir

The path to the compiler cache directory.

CredentialsFile
public static readonly string CredentialsFile
value = Paths.CredentialsFile

The path to the file with credentials.

DefaultSettingsExt
public const string DefaultSettingsExt
value = Paths.DefaultSettingsExt

Default extension for settings file.

FileSystem
public static readonly IFileSystem FileSystem
value = Paths.FileSystem

Default file system.

HistoryBeginDate
public static readonly DateTime HistoryBeginDate
value = Paths.HistoryBeginDate

Begin date of HistoryDataPath.

HistoryDataPath
public static readonly string HistoryDataPath
value = Paths.HistoryDataPath

Sample history data.

HistoryDefaultSecurity
public const string HistoryDefaultSecurity
value = Paths.HistoryDefaultSecurity

Sample history data security.

HistoryDefaultSecurity2
public const string HistoryDefaultSecurity2
value = Paths.HistoryDefaultSecurity2

Sample history data security.

HistoryEndDate
public static readonly DateTime HistoryEndDate
value = Paths.HistoryEndDate

End date of HistoryDataPath.

InstallerConsoleName
public const string InstallerConsoleName
value = Paths.InstallerConsoleName

Installer console exe name.

InstallerDir
public static readonly string InstallerDir
value = Paths.InstallerDir

The path to the installer directory.

InstallerInstallationsConfigPath
public static readonly string InstallerInstallationsConfigPath
value = Paths.InstallerInstallationsConfigPath

The path to the installer directory.

InstallerUIName
public const string InstallerUIName
value = Paths.InstallerUIName

Installer UI exe name.

LogsDir
public static readonly string LogsDir
value = Paths.LogsDir

The path to the logs directory.

PlatformConfigurationFile
public static readonly string PlatformConfigurationFile
value = Paths.PlatformConfigurationFile

The path to the configuration file of platform definition.

ProxyConfigurationFile
public static readonly string ProxyConfigurationFile
value = Paths.ProxyConfigurationFile

The path to the configuration file of proxy settings.

PythonUtilsPath
public static readonly string PythonUtilsPath
value = Paths.PythonUtilsPath

The path to the Python utils directory.

ReportLogsPath
public static readonly string ReportLogsPath
value = Paths.ReportLogsPath

The path to the settings directory.

SecurityExtendedInfo
public static readonly string SecurityExtendedInfo
value = Paths.SecurityExtendedInfo

The path to the directory with securities extended info.

SecurityMappingDir
public static readonly string SecurityMappingDir
value = Paths.SecurityMappingDir

The path to the directory with securities id mapping.

SecurityNativeIdDir
public static readonly string SecurityNativeIdDir
value = Paths.SecurityNativeIdDir

The path to the directory with native security identifiers.

SetupName
public const string SetupName
value = Paths.SetupName

Setup name.

SnapshotsDir
public static readonly string SnapshotsDir
value = Paths.SnapshotsDir

The path to the directory with snapshots of market data.

StorageDir
public static readonly string StorageDir
value = Paths.StorageDir

The path to the directory with market data.

TokenBasedEmail
public const string TokenBasedEmail
value = Paths.TokenBasedEmail

Email in case Token.