Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

ddsRegPreRefreshTrigger

ddsRegPreRefreshTrigger(
t_function
)
=> t / nil

Description

Registers a user-defined SKILL function that is called before executing the Refresh command using CIW - File - Refresh or the ddsRefresh SKILL function.

Arguments

t_function

Name of the SKILL callback function. The callback function has the following two arguments:

  • g_type specifies the type of data being refreshed. Supported value: 'cv
  • l_dataList lists IDs of the data that will be refreshed.

Value Returned

t

The specified function is registered successfully.

nil

The operation failed.

Examples

; Registers the function myRefreshCB, which is called before the Refresh command
starts.
procedure( myRefreshCB_pre( tag dataList )
    case( tag
 ('cv
     foreach( cv dataList
  info("**** %s %s %s will be refreshed\n"
      cv~>libName cv~>cellName cv~>viewName)
 )
 (t
     info("**** Received unknown refresh tag - %L\n" tag)
 )
    )
)
It has misprint and should be fixed to:
procedure( myRefreshCB_pre( tag dataList )
    case( tag
 ('cv
     foreach( cv dataList
  info("**** %s %s %s will be refreshed\n"
      cv~>libName cv~>cellName cv~>viewName)
  )
 )
 (t
     info("**** Received unknown refresh tag - %L\n" tag)
 )
    )
)
ddsRegPreRefreshTrigger( "myRefreshCB_pre" )

Related Topics

ddsRefresh


Return to top
 ⠀
X