geEnterAddTermProbe

geEnterAddTermProbe( 
[ w_windowId ] 
[ l_lpp ] 
[ lt_probeSpec ] 
[ g_repeatCmd ] 
)
=> o_probe 

Description

Adds a terminal probe to a window.

The terminal probe is displayed using the attributes of layer-purpose pair l_lpp.

If l_lpp is defaulted, a layer-purpose pair is chosen from the reserved layers y0 through y9 with purpose drawing. These default probing layers are cycled through so that successive probes can be highlighted in different colors.

lt_probeSpec is either a point or a string. If a point is specified, then the instance at that location is probed. If a string is specified, then the instance having that hierarchical path name is probed. The string should be in the format “/instname/instname/ .../objectName.” If lt_probeSpec is not specified, you are prompted to select a terminal to probe.

If g_repeatCmd is true, then all terminals of the current selection set are probed and highlighted with a different color. If no selection set exists, then multiple post-selection is enabled to probe terminals. If however, g_repeatCmd is nil, a single probe is added on a terminal.

Arguments

w_windowId	Database ID of the window to probe. The current window is used if w_windowId is not specified.
l_lpp	Layer-purpose pair on which to display the probe.
lt_probeSpec	Location in user units to probe at, or a string describing the probed object.
g_repeatCmd	SKILL expression specifying the probe selection mode, single select versus multiple post-select.

Value Returned

o_probe	Probe object created.
l_probes	A list of all the probes in w_windowId.

Examples

m = geEnterAddTermProbe( hiGetCurrentWindow() list( "y0" "drawing" ) nil t )

Related Topics

Probe Functions

Return to top