geEnterDeleteTermProbe

geDeleteTermProbe( 
[ w_windowId ] 
[ lt_probeSpec ] 
)
=> t / nil 

Description

Deletes a terminal probe from a window.

lt_probeSpec is the same type of probe specification as that used for adding a probe with the geAdd*Probe functions.

If g_repeatCmd is true, then delete all terminals of the current selection set and highlight with a different color. If no selection set exists, then enable multiple post-selection to delete probe on terminals. If however, g_repeatCmd is nil then delete a probe on a terminal.

Arguments

w_windowId	Database ID of the window to probe. The current window is used if w_windowId is not specified.
lt_probeSpec	Location in user units to look at for a terminal probe to delete, or a string describing a terminal probe to delete.
g_repeatCmd	SKILL expression specifying the probe selection mode, single select versus multiple post-select.

Value Returned

t	A probe was found and deleted.
nil	A probe was not found and deleted.

Examples

Deletes the terminal probe from the current window.

geEnterDeleteTermProbe( hiGetCurrentWindow() nil t )

Related Topics

Probe Functions

Return to top