hiAppendInputCmd

hiAppendInputCmd(
w_window 
t_cmd 
) 
=> t / nil

Description

Appends a command to the input area of an encapsulation window.

If the encapsulation window has the property obeySpecialChars set to t, this function treats the character ’\n’ in t_cmd as a newline (equivalent to pressing the carriage return key in the encapsulation window). If this property is not set, the ’\n’ and any characters following this in t_cmd are ignored.

Arguments

w_window	Encapsulation window ID returned from hiEncap.
t_cmd	SKILL function string to append to the input area.

Values Returned

t	The string is appended to the input area.
nil	The window specified by w_window is invalid or if the function t_cmd is null. A warning message is also issued.

Examples

w = hiEncap(list(100:100 500:500) "" "encap")
w->obeySpecialChars = t
hiAppendInputCmd(w "ab")   ; input has ’ab’
hiAppendInputCmd(w "cd")    ; input has ’abcd’
hiAppendInputCmd(w "\n")   ; sends ’abcd’ to output
hiAppendInputCmd(w "ab\ncd\nef")      
   ; sends ’ab’ to output
   ; sends ’cd’ to output
   ; input has ’ef’
hiAppendInputCmd(w "gh\n")   ; sends ’efgh’ to output

Related Topics

Encapsulation Window

hiEncap

Return to top