lmgrBeginBatchChange

lmgrBeginBatchChange( 
) 
=> t

Description

Activates batch change mode to improve the performance of Library Manager for handling lmgrSetLibDisplayOverride calls.

lmgrBeginBatchChange supports a nesting feature that helps control the flow of multiple independent source code blocks using the batch change feature. When lmgrBeginBatchChange is called to activate batch change mode to an already active batch mode, a new, nested batch change scope is created. All nested scopes created require an equal number of lmgrEndBatchChange calls to be deactivated.

Deactivating the first lmgrBeginBatchChange call and all the subsequent nested scopes deactivates batch change mode this final transition triggers the display of the overrides in Library Manager. If all the nested scopes are not deactivated, the status of batch change mode remains active indefinitely and the Library Manager does not display the intended override data.

Using errset with lmgrBeginBatchChange is recommended to ensure that lmgrBeginBatchChange is always followed by a matching call to lmgrEndBatchChange.

Arguments

None

Value Returned

t	Batch change mode is activated.

Examples

Using errset with set calls to call a matching lmgrEndBatchChange.

lmgrBeginBatchChange()

    errset( lmgrSetLibDisplayOverride( list("US_8ths" "basic") ?icon "test.png" ?color "green") t )

    errset( lmgrSetLibDisplayOverride( "cdsDefTechLib" ?color "#ff0000" ?icon "locked.png") t )

lmgrEndBatchChange()

Related Topics

lmgrInBatchChange

lmgrEndBatchChange

Return to top