fsVarsBVarStringGet
The fsVarsBVarStringGet function can be used to get the value of a specific BVar containing a string.
Syntax
FsVarError fsVarsBVarStringGet(
FsBVarId bVarId,
char* buffer,
int bufferSize,
FsObjectId target
);Parameters
| Parameters | Description |
|---|---|
bVarId | The ID of a BVar (found using fsVarsGetBVarId). |
buffer | The buffer that will receive the value of the BVar if the other parameters are correct. |
bufferSize | The size of the given buffer. |
target | The ID of the object from which the variable is being retrieved. Default: FS_OBJECT_ID_USER_AIRCRAFT. |
Return Values
The function returns a FsVarError, where 0 means there is no error (in which case, the value of the BVar has been copied to buffer).
Example
FsBVarId bVarId = fsVarsGetBVarId("BVarString", false);
char buffer[128];
buffer[0] = '\0';
if (fsVarsBVarStringGet(bVarId, buffer, sizeof(buffer), FS_OBJECT_ID_USER_AIRCRAFT) == FS_VAR_ERROR_NONE)
{
// valid
}
else
{
// error
}