# fsVarsRegisterCustomSimVar<no value>

{{< callout context="note" title="NOTE" icon="outline/bulb" >}}

Deprecated. Use `fsVarsRegisterIVar, `[fsVarsRegisterOVar](fsvarsregisterovar/)` or `[fsVarsRegisterZVar](fsvarsregisterzvar/)instead.

{{< /callout >}}

The **fsVarsRegisterCustomSimVar** function can be used to create a new custom simulation variable.

 

##### Syntax

``` wasm
FsCustomSimVarId fsVarsRegisterCustomVar(
    const char* name,
    const char* componentPath,
    eFsSimCustomSimVarScope scope
);
```

 

##### Parameters

<table><thead><tr class="header"><th>Parameters</th><th>Description</th></tr></thead><tbody><tr class="odd"><td><code>name</code></td><td><p>The name of the new variable.</p></td></tr><tr class="even"><td><code>componentPath</code></td><td>The path of the component if relevant. nullptr otherwise  

The path format is : <code>path:to:component</code> or <code>path:to:component@alias</code>.The alias is not mandatory but is recommended for performance issue an to avoid conflicts.</td></tr><tr class="odd"><td><code>scope</code></td><td>The scope of the new custom simvar.</td></tr></tbody></table>

 

##### Return Values

The function returns the right Id associated to the given name. If an error occurred, the function will return -1.

 

##### Example

``` wasm
FsCustomSimVarId varId = fsVarsRegisterCustomSimVar("TOTO", nullptr, FsSimCustomSimVarScopeSim);
```