removeAccessAccount() 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

  • Remove a client level access account from the system

Syntax

  • Boolean = AeXMLBridge.removeAccessAccount(AeAccessAccount);

Parameters

Return Value

  • Returns a boolean value that is True if successful; false otherwise

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
TAeAccessAccount[] accts = ws.getAccessAccounts();                        
 // retrieve a list of access accounts
 
if (accts.Length > 0)
{                                                                        
   try
   {
      bool success = ws.removeAccessAccount(accts[0]);
       // will not remove account if it is the only account left
   }
   catch (Exception ex)
   {
      MessageBox.Show(ex.Message);
   }
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim accts As TAeAccessAccount() = ws.getAccessAccounts()
' retrieve a list of access accounts
 
If accts.Length > 0 Then
    Try
        Dim success As Boolean = ws.removeAccessAccount(accts(0))
        ' will not remove account if it is the only account left

    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
End If

Remarks

  • There needs to be more than one access account to be able to remove one

Possible Errors

  • Account does not exist

accessAccountCodeExists
addAccessAccount
addAccessAccountWorkgroupAccessRightByAccountCode
editAccessAccount
getAccessAccounts
getAccessAccountViaAccountCode
getAccessAccountViaUniqueID
getAccessAccountWorkgroupAccessRightsByAccountCode
getCurrentAccessAccount
getEmptyAccessAccount
loadAccessAccountActivitysInRange
removeAccessAccountAllWorkgroupAccessRightsByAccountCode

Back to Top