Ets_Obj_Install_Interactive()
Abstract
Interactively adds a site, link, or path object to an open network model.
Syntax
Ets_Obj_Install_Interactive (installee_hndl, abort_handler, completion_handler, state_ptr)
| Argument | Type | Description |
|---|---|---|
installee_hndl |
EtsT_Obj_Handle |
Handle to the object to be installed. |
abort_handler |
EtsT_Obj_Interactive_Installation_Callback |
Handler function to be invoked if user cancels the operation. |
completion_handler |
EtsT_Obj_Interactive_Installation_Callback |
Handler function to be invoked if user completes the operation. |
state_ptr |
void* |
Client-specified state pointer to be passed to completion_handler() or abort_handler(). |
Return Type
EtsT_CompCode
EtsC_CompCode_Success if the operation was successful; otherwise EtsC_CompCode_Failure.
Header
ets_api_obj.h
Details
This function is equivalent to selecting and dragging an object from the object palette, and invokes one of two functions:
completion_handler()—Called once the user has selected and dragged the object into the networkabort_handler()—Called if the user cancels the operation
abort_handler() and completion_handler() are optional callback functions; their prototype is given in EtsT_Obj_Interactive_Installation_Callback.
The object referenced by installee_hndl must be a site, link, or path object that has not yet been installed. Note that an object’s base attributes (such as “model”) must be set prior to calling this function.
This function owns the to-be-installed object until it terminates. For this reason, the object referenced by installee_hndl cannot be destroyed by any other process until Ets_Obj_Install_Interactive() terminates.