Object Model: XSIApplication.ActivateWorkgroup

XSIApplication.ActivateWorkgroup

Introduced

v5.0

Description

Activates or deactivates a workgroup. Deactivating a workgroup is very similar to calling XSIApplication.RemoveWorkgroup except that Softimage will continue to remember the workgroup path. This makes it easier for users to remember which workgroups they have connected to in the past. Softimage will not scan a deactivated workgroup for plug-ins and it will not be returned as part of the XSIApplication.Workgroups property.

Note: Deactivated plug-ins are still stored in the "data_management.workgroup_appl_path" preference but they are prefixed with a "!" character.

C# Syntax

XSIApplication.ActivateWorkgroup( String in_workgrouppath, Boolean in_bActivate );

Scripting Syntax

XSIApplication.ActivateWorkgroup( WorkgroupPath, [Activate] );

Parameters

Parameter	Type	Description
WorkgroupPath	String
Activate	Boolean	Send true to activate the workgroup, or false to deactivate it. Default Value: true

Examples

1. JScript Example

/*
        This example shows how to deactivate all active workgroups.
*/
aWorkgroups = new VBArray( Application.Workgroups ) ;
cntWorkgroups = aWorkgroups.ubound( 1 ) + 1
for ( var i=0; i<cntWorkgroups; i++ ) {
        Application.ActivateWorkgroup( aWorkgroups.getItem( i), false ) ;
}

2. VBScript Example

'
'       This example shows how to deactivate all active workgroups.
'
aWorkgroups = Application.Workgroups 
for i=0 to UBound( aWorkgroups, 1 ) 
        Application.ActivateWorkgroup aWorkgroups(i), false 
next