hiSetEncapSkillCmd

hiSetEncapSkillCmd(
w_windowId
t_skillCmd 
) 
=> t / nil

Description

Registers the SKILL function that wraps or embraces the input command line entered during the current encapsulation session.

Any input entered in the input window of the encapsulation window is redirected to the SKILL function t_skillCmd. This function should accept only one argument—the string that is the line of input to the encapsulation window.

If the property sendAllInput is set to t on the encapsulation window, an empty string is passed to the t_skillCmd function. If the property is not set, the default action is that single carriage returns are ignored.

Arguments

w_windowId	Encapsulation window ID returned by hiEncap.
t_skillCmd	SKILL function to use as the wrapper function.

Values Returned

t	The function is registered.
nil	The function is not registered. A warning is also issued.

Examples

Create the procedure to be used as the wrapper:

procedure(processString(input "t")
;process the input string typed to the encapsulation 
;window
...
)

Create an encapsulation window:

w = hiEncap(list(100:100 500:500))

hiSetEncapSkillCmd(w "processString")

When input is typed in the encapsulation window:

countAll

the wrapper function is set up, using the encapsulation window input as its argument:

processString("countAll")

The processString function then processes the input string and either redirects it to another process or calls the appropriate function.

Related Topics

Encapsulation Window

hiEncap

Return to top