Load DataShare File

Loads a set of arguments from a DataShare file. Datashare files are text files that define a set of named values for easy data storage. They are read and parsed adding additional arguments to the MP command, providing a convenient way to have access to data.

 

Input Arguments

 

0

File Path or Embedded File

DataShare File Path

The path to the DataShare file to load.

1

Boolean

Make Variables?

True builds variables from the Datashare file.

Return Arguments

None.

 

Returned Status

 

SUCCESS

The file was successfully loaded.

FAILURE

The file could not be loaded or had an invalid format.

Remarks

In order to populate this command with the proper list of arguments (so that they can be referenced later in the script), you must first specify a path to an actual DataShare file of the same format, then click the Refresh Arguments button. This will populate the command with the appropriate arguments, and the file path can subsequently be set to the desired value.

The expected datashare format is as follows:

<ASCII>

<S: String Name>

“String”

<B: Boolean Name> 0

<I: Integer Name>

32

<D: Double Name>

3.2000000000000002e+00

<V: Vector Name>

1.000000 0.020000 0.030000

<T: Transform name>

0.010000 0.020000 0.030000 0.040000 0.050000 0.060000

This command supports both absolute paths (ex. C:\test.xit) and relative paths (ex. .\test.xit). This command is not supported via the SA SDK--data can be loaded from files using language-specific commands.

Make Variables? If enabled, the datashare values are saved as variables, defined using the argument names, and can be used while a script is running. This option was added in 2022.3 and will build variables as long as the argument names are unique.