gpeClearMatchGroups

gpeClearMatchGroups(
u_sandbox
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Removes all the matched groups from the specified Modgen sandbox object.

Arguments

u_sandbox	Specifies a Modgen sandbox object.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

t	All the matched groups were removed from the Modgen sandbox object.
nil	The command was unsuccessful.

Example

In the following example, a matched group mg1 of match type widenFirst is created and then added to a Modgen sandbox object. gpeClearMatchGroups is then used to remove all the matched groups from the Modgen sandbox object.

mg1 = gpeCreateMatchGroupEntry(0 ?twigMatchType "widenFirst")

gpeAddMatchGroups(sandbox list(mg1))

gpeClearMatchGroups(sandbox)

Return to top