geExplainProbe

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

Description

Explains the probes in a window.

A view file window with information on each of the probes described by lt_probeSpec is displayed for you to view. lt_probeSpec is the same kind of specification used for the geAdd*Probe functions. If a point is specified, all probes within the selection aperture of the specified point are explained.

The information for the file shown is put into a temporary file in /tmp.

Arguments

w_windowId	Database ID of the window containing the probes you want explained. The current window is used if w_windowId is not specified.
lt_probeSpec	Location in user units to look at for probes to explain, or a string describing a probe to explain.

Value Returned

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

Examples

Explains any probes under the point 10:10 in window(3).

geExplainProbe( window(3) 10:10 )

Related Topics

Probe Functions

Return to top