Rpstr_RemoveValue.md

Rpstr_RemoveValue

Description

Removes a named value from the VectorScript value repository.

FUNCTION Rpstr_RemoveValue(name : STRING): BOOLEAN;

def vs.Rpstr_RemoveValue(name):
    return BOOLEAN

Parameters

Name	Type	Description
name	STRING	The name of the value.

Examples

resultOK := Rpstr_RemoveValue('Example');

import vs

# Removes a named value from the VectorScript value repository.
name = 'Example'

ok = vs.Rpstr_RemoveValue(name)
if ok:
    vs.Message('Rpstr_RemoveValue succeeded')
else:
    vs.Message('Rpstr_RemoveValue failed')

See Also

VS Functions: Rpstr_RemoveValues | Rpstr_RemoveValue | Rpstr_GetValueBool | Rpstr_SetValueBool | Rpstr_GetValueInt | Rpstr_SetValueInt | Rpstr_GetValueReal | Rpstr_SetValueReal | Rpstr_GetValueStr | Rpstr_SetValueStr

Version

Availability: from Vectorworks 2012

Category

• Utility