delWorkgroup() Method

Table of Contents

  1. Function
  2. Syntax
  3. Parameters
  4. Return Value
  5. Sample Code
  6. Remarks
  7. Possible Errors
  8. Related Methods

Function

  • Removes a workgroup number from a specified workgroup level and replaces it with a new workgroup number

Syntax

  • AeXMLBridge.delWorkgroup(WGLevel, WGNum, ReplacementWGNum, UseValidationTable);

Parameters

  • Integer - workgroup level (1-7)
  • Integer - workgroup number to be removed
  • Integer - replacement (new) workgroup number
  • Boolean - normally set to false; setting to true forces the system to use the internal workgroup validation table

Return Value

  • None

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
int wgLevel = 2;                 
int wgNum = 3;                   
int wgReplacementNum = 4;
bool useValidation = false;
 // we are going to delete workgroup level 2 number 3 and replace it with
 // level 2 number 4

try
 {
    ws.delWorkgroup(wgLevel, wgNum, wgReplacementNum, useValidation);
 }
catch (Exception ex)
 {
    MessageBox.Show(ex.Message);
 }

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
13
Dim wgLevel As Integer = 2
Dim wgNum As Integer = 3
  
Dim wgReplacementNum As Integer = 4
' we are going to delete workgroup level 2 number 3 and replace it with level 2 number 4
  
Dim useValidation As Boolean = False
  
Try
     ws.delWorkgroup(wgLevel, wgNum, wgReplacementNum, useValidation)
Catch ex As Exception
     MessageBox.Show(ex.Message)
End Try

Remarks

  • Must be an existing workgroup level
  • Must be an existing workgroup number

Possible Errors

  • Invalid object name “Workgroupx” (x = workgroup level)
  • Workgroup Level/Num in use and removal not allowed absent defined replacement
  • Invalid Replacement Workgroup Level:x Replacement WGNum:y (x = workgroup level; y = replacement number)

addDeptXlateItem
addWorkgroup
delWorkgroup
extractDeptXlateItems
extractWGXlates
getWorkgroup
getWorkgroupLevelDetails
getWorkgroups
getWorkgroupStruct
getWorkgroupViaCode
getWorkgroupViaName
maintainWGXlate
nextWGNumForWGLevel
removeDeptXlateItem
removeWGXlate
setWorkgroup
setWorkgroupLevelLabels

Back to Top