Scripting: RemoveUserKeyword

RemoveUserKeyword

Introduced

v8.0 (2010)

Description

Removes one or more user keyword(s) from the list of keywords of each object in the specified list. If you specify a keyword that does not exist in the list, nothing happens (no error occurs).

Scripting Syntax

RemoveUserKeyword( [InputObjs], Keywords );

Parameters

Parameter	Type	Description
InputObjs	SelectionList or Selection	Default Value: If not specified, the current selection is used.
Keywords	String

Examples

VBScript Example

NewScene
CreatePrim "Sphere", "MeshSurface"
CreatePrim "Cone", "MeshSurface"
CreatePrim "Torus", "MeshSurface"
SetUserKeyword "sphere,cone", "blue,orange"
AddUserKeyword "sphere", "red,brown"
AddUserKeyword "torus", "yellow,teal"
RemoveUserKeyword "sphere,cone,torus","yellow,orange"
dim KeywordCollection 
set KeywordCollection = GetUserKeyword( "sphere" )
for each keyword in KeywordCollection
LogMessage "sphere keyword:" & keyword
next
LogMessage "All Keywords:"
set KeywordCollection = GetUserKeyword( "sphere,cone,torus" )
for each keyword in KeywordCollection
LogMessage keyword
next