axlRegisterJobIntfc
axlRegisterJobIntfc(
s_displayName
s_className
[ ?isInitializedFun u_isInitFun ]
[ ?displayInGUI g_shouldDisplay ]
)
=> t
Description
Registers a job interface class into the application. Job interfaces should be registered before use, preferably during virtuoso initialization.
Arguments
|
s_displayName
|
String name to store in the job policy and display in the Job Policy GUI.
|
|
s_className
|
Name of a derived class from axlJobIntfc.
|
|
?isInitializedFun u_isInitFun
|
|
|
Specifies a function to be called on initialization, before any jobs are submitted. The function shall accept two string arguments: the first is the displayName, the second, the className.It shall return t if initialization was succesful and nil otherwise. If initialization fails, the application will display an error and use the built in job policy.
By default, the function only returns t.
|
|
?displayInGUI g_shouldDisplay
|
|
|
Boolean that switches whether the display name will be listed in the Distribution Method cyclic field on the Job Policy Setup form. It would be useful to pass nil in order to provide a policy-specific Job Policy GUI Customization (as registered with axlRegisterJPGUICust) which could be used to provide additional interface arguments.
|
Value Returned
|
t
|
The job interface class is registered into the application.
|
Examples
Registers the job interface class into the application.
axlRegisterJobIntfc("Localhost IPC" '_axlIPCJobIntfc)
=> t
Return to top
