getWorkgroupViaName() Method

Table of Contents

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

Function

  • Returns details about a specific sub workgroup using the workgroup level and an associated sub workgroup name

Syntax

  • AeWorkgroup = AeXMLBridge.getWorkgroupViaName(WGLevel, WGName);

Parameters

  • Integer - workgroup level (1 - 7)
  • String - sub workgroup code

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13

int wgLevel = 1;                                                               
// Location
string wgName = "Livonia";
  
try
{
   TAeWorkgroup workgroup = ws.getWorkgroupViaName(wgLevel, wgName);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11

Dim wgLevel As Integer = 1
' Location
  
Dim wgName As String = "Livonia"
  
Try
     Dim workgroup As TAeWorkgroup = ws.getWorkgroupViaName(wgLevel, wgName)
Catch ex As Exception
     MessageBox.Show(ex.Message)
End Try

Remarks

  • Invalid WGName will return an empty structure

Possible Errors

  • WGLevel must be 1 - 7

Alternate Method

getWorkgroupViaCode

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

Back to Top