fsVarsGetZVarId

The fsVarsGetZVarId function can be used to get an existing ZVar (which is the same as an L:1 variable).

Syntax#

FsLVarId fsVarsGetIVarId(
    const char* name,
    FsObjectId target
);

Parameters#

Return Values#

The function returns the ID associated with the given variable name. If the given name has not been registered, the function will return FS_VAR_INVALID_ID. If an error occurred, the function will return FS_VAR_INVALID_ID.

Remarks#

ZVar are variables local to a specific SimObject (if there are multiple instances of the object, each one will have its own unique variable).

Example#

FsZVarId zVarId = fsVarsGetZVarId("TOTO");