hiSetEncapPrompt

hiSetEncapPrompt(
w_window 
t_prompt 
) 
=> t / nil

Description

Sets the prompt for an encapsulation window.

Arguments

w_window	Encapsulation window ID returned by hiEncap.
t_prompt	String to be used as the prompt. The default prompt is the greater than character (>).

Value Returned

t	The prompt is set.
nil	The prompt is not set. An error message is also issued.

Examples

Returns t and displays the prompt “What_now?” directly above the input line in the encapsulation window.

hiSetEncapPrompt(w "What_now?")

Related Topics

Encapsulation Window

hiEncap

Return to top