getAccessAccountViaAccountCode() Method

Table of Contents

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

Function

  • Extracts the details of a specific access account using the account code

Syntax

  • AeAccessAccount = AeXMLBridge.getAccessAccountViaAccountCode(AccountCode);

Parameters

  • String - account code

Return Value

Sample Code

C#

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
TAeAccessAccount[] accounts = ws.getAccessAccounts();                      
// retrieve a list of Access Accounts
 
foreach (TAeAccessAccount accessAcct in accounts)                          
// iterate through the list to get the account code you want
{
   try
   {
      TAeAccessAccount acct = ws.getAccessAccountViaAccountCode(accessAcct.AccountCode);
   }
   catch (Exception ex)
   {
      MessageBox.Show(ex.Message);
   }
}

VB.Net

1
2
3
4
5
6
7
8
9
10
11
12
Dim accounts As TAeAccessAccount() = ws.getAccessAccounts()
' retrieve a list of Access Accounts
 
For Each accessAcct As TAeAccessAccount In accounts
' iterate through the list to get the account code you want

    Try
        Dim acct As TAeAccessAccount = ws.getAccessAccountViaAccountCode(accessAcct.AccountCode)
    Catch ex As Exception
        MessageBox.Show(ex.Message)
    End Try
Next

Remarks

  • Use getAccessAccounts to retrieve a list of access accounts containing the account code parameter
  • Account returned executing the method will not display the password value

Possible Errors

  • Account Code not in system

Alternate Methods

getAccessAccountViaUniqueID

accessAccountCodeExists
addAccessAccount
addAccessAccountWorkgroupAccessRightByAccountCode
editAccessAccount
getAccessAccounts
getAccessAccountWorkgroupAccessRightsByAccountCode
getCurrentAccessAccount
getEmptyAccessAccount
loadAccessAccountActivitysInRange
removeAccessAccount
removeAccessAccountAllWorkgroupAccessRightsByAccountCode

Back to Top