geSetCrossProbeValue

geSetCrossProbeValue( 
t_viewTypeName 
[ g_value ] 
)
=> t / nil 

Description

Sets the view types to cross-probe.

The crossProbe form is created only on the first addProbe menu command. If this function is called before the crossProbe form is created, then a list of defaults is accumulated. During the creation of the crossProbe form, the default list is checked to see if the value on the form defaults to true.

Arguments

t_viewTypeName	Name of a view type to cross-probe. The crossProbe form is initialized with this value if the form is not created yet or if the form has a value corresponding to this value set on the existing crossProbe form. This argument can be set to all or none.
g_value	Value assigned to crossProbe.

Value Returned

t	Returns t by default.
nil	If t_viewTypeName is all or none, this value is ignored.

Examples

Set to cross probe graphic view types by default.

geSetCrossProbeValue( "graphic" t )

Related Topics

Probe Functions

Probe File Format

Return to top