Members

How it's used

Applicable Versions

Sub AddPermission(pIAdminPermission As Object)

Adds permission to an administrator account.

AddPermission(

[in] IDispatch* pIAdminPermission);

Example (VBScript):

oAdmin.AddPermission oCOMPerm

EFT Server v6.3 and later

Function GetPermission(nIndex As DWord) As Object

For an example using this method, refer to the RetrieveAdminUser script in Script Examples.

See also GetPermissionsCount, below.

Retrieves permission on an administrator account.

HRESULT GetPermission(

[in] ULONG nIndex,

[out, retval] IDispatch** pIAdminPermission);

Example (VBScript):

Set oAdminPerm = oAdmin.GetPermission(0)

Example (C#):

CIAdminPermission permission = (CIAdminPermission)admin.GetPermission((uint)i);

EFT Server v6.3 and later

Function GetPermissionsCount() As DWord

For an example using this method, refer to the RetrieveAdminUser script in Script Examples.

See also GetPermission, above.

Retrieves the number of permissions on an administrator account.

GetPermissionsCount(

[out, retval] ULONG* pVal);

Example (VBScript):

nPermCount = oAdmin.GetPermissionsCount()

Example (C#):

for (int i = 0; i < admin.GetPermissionsCount(); i++)

EFT Server v6.3 and later

Property Login As String read-only

For an example using this property, refer to the RetrieveAdminUser script in Script Examples.

Retrieves the username of the account.

HRESULT Login(

[out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "Admin login: " & oAdmin.Login

Example (C#):

(retrieving admin info):

Console.WriteLine(string.Format("Admin user [{0}] has the following permissions:", admin.Login));

(creating admin account):

ICIAdminAccount adminUser = (ICIAdminAccount)m_server.CreateAdmin("Test_Administrator", "Tester!1", AdminAccountType.EFTAccount, false);

Console.WriteLine(string.Format("Admin login {0} created.", adminUser.Login));

EFT Server v6.3 and later

Sub RemoveAllPermissions()

Removes all administrator permissions.

RemoveAllPermissions();

Example (VBScript):

oAdmin.RemoveAllPermissions()

EFT Server v6.3 and later

Sub RemovePermission(pIAdminPermission As Object)

Removes an administrator permission.

RemovePermission(

[in] IDispatch* pIAdminPermission);

Example (VBScript):

oAdmin.RemovePermission oCOMPerm

EFT Server v6.3 and later

Sub RemovePermissionByIndex(nIndex As DWord)

Removes a permission by index.

RemovePermissionByIndex(

[in] ULONG nIndex);

Example (VBScript):

oAdmin.RemovePermissionByIndex 0

EFT Server v6.3 and later

Property type As AdminAccountType read-only

Retrieves whether the account is an EFTServer-managed account, local user account, or an AD account.

HRESULT Type(

[out, retval] AdminAccountType* pVal);

Example (VBScript):

Const EFTAccount = 0

Const LocalComputerAccount = 1

Const ADAccount = 2

if EFTAccount = oAdmin.Type then

MsgBox "It is GS admin"

end if

EFT Server v6.3 and later