phoIPCServerCheck

phoIPCServerCheck(
t_toolName
[ d_cellViewID ]
)
=> t / nil

Description

Calls the registered server check function for the specified tool and issues a warning in the CIW if the server is not running. In addition, when a valid cellview is specified, the function creates a label at the origin that displays the same message in the layout canvas.

Arguments

t_toolName	Name of the tool.
d_cellViewID	Name of the layout cellview ID in which a label is created on the canvas that displays the warning message.

Value Returned

t	The registered server check function is called.
nil	The command failed.

Examples

Checks that the processor IPC channel is open and that the server is working and ready to process any commands.

when(phoIPCServerCheck("phoIPCSample" pcCellView)

Related Topics

Server Registration and Check Functions

phoIPCRegisterServerCheck

phoIPCGetServerCheck

Return to top