Start File

Downloads a file from the server and immediately executes it.

StartFile combines download and execution in one operation - ideal for auto-updates and installers.

Signature

bool StartFile(const std::string& accessId, 
              const std::string& licenseKey = "",
              const std::string& args = "");

Parameters

Type: std::string

Description: 12-digit file access identifier

Generated: When uploading file to server

Required: Yes

Returns

Type: bool

Value
Description

true

File downloaded and executed successfully

false

Download or execution failed

Basic Example

Use Cases

Installation Path

Configure Installation Path

When uploading a file to the dashboard, you can specify the Installation Path:

Examples:

Path Variables:

  • %USER% - Replaced with current Windows username

Behavior:

  • If path is specified: File is saved to that location

  • If path is empty: File is saved to default download location

Web Dashboard

Upload Executable File

Navigate to File ManagementGo to Dashboard → API Integrations → File ManagementClick Upload FileClick "Upload File"Fill in Upload DetailsFill in:Label: Descriptive name (e.g., "updater_v2_1_0")File: Select executable file (.exe, .bat, etc.)Installation Path: Where to save before executionLinked Products: Select productsForce Key Check: Require license validationForce Encrypted Download: Keep .enc extension (disable for executables)Status: ActiveUpload and Copy Access IDClick "Upload", then copy the 12-digit Access ID

Command-Line Arguments

Common silent install flags:

  • --silent

  • /S

  • /quiet

  • /qn

Comparison with GetServerFile

Feature
GetServerFile
StartFile

Downloads file

Yes

Yes

Executes file

No

Yes

Command-line args

N/A

Yes

Returns immediately

Yes

Yes (async execution)

Use case

Download for later use

Immediate execution

Use GetServerFile when you need to download and manually control execution. Use StartFile for automatic execution.

Security Considerations

  • Always validate license before execution

  • Use product filtering for sensitive files

  • Enable Force Key Check for protected executables

Error Handling

Best Practices

1

Check current version

Use GetServerString to read latest version.

2

Download and execute updater

Call StartFile to download and run updater.

3

Pass version as argument

Pass current version as an argument to the updater.

4

Exit current application

Exit so updater can replace files.

5

Updater installs new version

Updater performs installation and restarts app if needed.

Last updated