Vicon Shogun banner

Description

Removes a directory from the list of script directories that is searched when Shogun Post builds its internal list of script and pipelines.

By default, this command does not cause the internal list to get rebuilt. To force an immediate rebuild, specify the -reparse flag.

If the path specified does not exist in Shogun Post's script directory list, then the command has no effect.

Functional area

System

Command syntax

Syntax

deleteScriptPath ScriptPath [-reparse]

Arguments

NameTypeRequiredComments
ScriptPathstringyesThe full path to the script directory to remove from the script directory list. Use forward slashes.

Flags

NameFlag argumentsArgument typeExclusive toComments
reparse0Reparses the script directories immediately. If not specified, then the script directories will only be reparsed on next Shogun Post launch.

Return value

void

Examples

// Remove the given script path and immediately reparse the script
// directories
deleteScriptPath "C:/Program Files/Vicon/ShogunPost#.#/MyScripts/OldScripts/";

Additional information

Related commands