Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

enterString

enterString(
[ ?prompts l_promptList ] 
[ ?form s_form ]
[ ?initProc t_initProcName ] 
[ ?doneProc t_doneProcName ]
[ ?formProc t_formProcName ]
[ ?alwaysMap g_alwaysMap ]
[ ?cmdName t_cmdName ]
[ ?cursor x_cursor ]
) 
=> t_string

Description

Prompts you to enter a string.

The function terminates when you press a carriage return in the CIW.

Arguments

?prompts l_promptList

  

List of prompt strings to be displayed in the CIW. Only the first string is used.

?form s_form

Options form created with hiCreateOptionsForm. This form is displayed when you call hiToggleEnterForm. It contains options relevant to the enterfunction and its caller.

?initProc t_initProcName

  

Name of the SKILL function to be called immediately after the enterfunction is started and before any data entry.

?doneProc t_doneProcName

  

Name of the SKILL function to be called when the enterfunction is terminated.

?formProc t_formProcName

  

Name of the SKILL function to be called when the options form is displayed.

?alwaysMap g_alwaysMap

  

Determines whether or not to immediately display the options form.

?cmdName t_cmdName

  

Name you associate with the enterfunction. If the command name is set, it can be accessed with hiGetCurrentCmd.

?cursor x_cursor

An integer argument that will default to an appropriate cursor. For example, hicArrowRectangle for enterBox and hicArrowArc for enterArc. For more information on all available cursors see hiSetCursor.

Value Returned

t_string

The string you typed.

Retrieve data through the callback procedure t_doneProcName instead of using the return value for this enterfunction.

Examples

enterString( ?prompts list( "Enter layer name." ))

The prompt “Enter layer name” is displayed on the prompt line. When you type a string followed by a carriage return, the enterfunction returns that string.

Related Topics

User Entry Functions

hiCreateOptionsForm

undrawEnterFun

hiGetCurrentCmd


Return to top
 ⠀
X