Easy-IP API Documentation
Table Of Contents

This document is split into the following sections:

Easy-IP Library Description

The Easy-IP Library contains services and methods that allow you to access the entire functionality of the Easy-IP server. You can access the API in two different ways:

  1. A SOAP API - To connect to the API you need to enable the SOAP server via the server settings. A simple example of using the SOAP API in Delphi is included in the Easy-IP server installation.
  2. RemObjects DataAbstract components. This method uses a binary protocol and is by far the most efficient method. It requires the purchase of third party software. Visit www.remobjects.com for more information.

Services

The following table lists the Services defined in "EasyIPLibrary":

EasyIPCore(BaseEasyIPService)
Core Easy-IP functions.
LoginService(BaseEasyIPService)
Provides login/logout functionality. This is the only service that can be accessed without a client session being created.
EasyIPAdmin(BaseEasyIPService)
This service is used to access Easy-IP Administration functionality. All funtionality in this service requires Manager, SAdministrator or Super Administrator rights.
EasyIPEdit(BaseEasyIPService)
All editing functionality is included in this service.
LocalService(BaseEasyIPService)
Used internally
BaseEasyIPService
BaseEasyIPService is the ancestor of all other Easy-IP services and cannot be accessed directly
EasyIPTools(BaseEasyIPService)
The tools service provides various functionality such as export, missing subnet generation etc.
EasyIPDiscovery(BaseEasyIPService)
This service deals with all aspects of host discoveries. Discovery bot functionality is also included here.
EasyIPReport(BaseEasyIPService)
This service provides reporting functionality.
EasyIPUtils(BaseEasyIPService)
The Utils service exposes helper functionality.
Service EasyIPCore

The following table lists the Operations defined in "EasyIPCore":

AddOrUpdateVirtualFile
Adds or updates a virtual server file.
AddVirtualDirectory
Adds a virtual server directory.
CancelOperation
Cancels the asynchronous operation specified by the operation ID.
CheckUserFunctionAllowed
Checks to see if a user function if allowed.
CopyVirtualDirectoryContents
Copies the contents of one virtual server directory to another.
DeleteDownloadFile
Deletes a server file that has been downloaded to a client. A server file is not the same as a virtual server file. A virtual server file is stored in the database. A server file is generated by the server and stored in the local file system ready to be downloaded by a user.
DeleteVirtualDirectory
Deletes a virtual server directory.
DeleteVirtualFile
Deletes a virtual server file.
GetAddressData
Returns the IP address data in a binary format.
GetAddressData2
Returns the IP address records as simple data.
GetAutonomousNetworkNameFromId
Returns the name of an autonomous network given it's ID.
GetAutonomousNetworkNotes
Returns the notes of an autonomous network given it's ID.
GetAutonomousNetworks
Returns the autonomous networks available to the current user in a binary format.
GetAutonomousNetworks2
Returns the autonomous networks available to the current user as simple data.
GetChangeLogEntries
Returns an array of change log entries.
GetChangeLogRevisions
Returns an array of revisions associated with a change log.
GetChildNodes
Returns the child nodes of an item in a binary format. User data is not included.
GetChildNodes2
Returns the child nodes of an item as simple data. User data is not included.
GetClientSettings
Returns the current user settings.
GetDownloadFilePart
Returns a portion of a server file.
GetDownloadFileSize
Returns the size of a server file.
GetEasyIPUser
Returns information about the current Easy-IP user.
GetFullTextSearchProgress
Returns information about the status of Full Text Search indexing.
GetIPAddressesBySubnet
Returns a list of IP addresses that exist in a subnet in a binary format.
GetIPAddressesBySubnet2
Returns a list of IP addresses that exist in a subnet as simple data.
GetIPAddressIdAndSubnetId
Returns the subnet ID and IP address ID given the autonomous network ID and IP address.
GetItemData
Returns the child groups/subnets in a binary format.
GetItemData2
Returns the child groups/subnets as simple data.
GetItemRangeLimits
Returns the IP address range limits for a group or subnet.
GetLastUndoItem
Returns the last undo item for the current user.
GetLicenceDetails
Returns information about the Easy-IP licence.
GetLinkedIPAddressDescriptions
Returns a list of Linked IP address descriptions.
GetLinkedIPAddresses
Returns an array of IP addresses that are linked to the specified IP address.
GetLongSubnetPathFromSubnetId
Returns a descriptive path given a group or subnet ID.
GetPingHistory
Returns the ping history of a specific IP address.
GetRootData
Returns the root groups/subnets of an autonomous network in binary format.
GetRootData2
Returns the root groups/subnets of an autonomous network as simple data.
GetRootNodes
Returns the root nodes of an autonomous network in a binary format. No user data is included.
GetRootNodes2
Returns the root nodes of an autonomous network as simple data. No user data is included.
GetItemById
Returns group or subnet data in a binary format.
GetItemById2
Returns group or subnet data as simple data.
GetItemByInfo
Returns group or subnet data in a binary format.
GetItemByInfo2
Returns group or subnet data as simple data.
GetItemParentIds
Returns the parent IDs of a group or subnet.
GetSystemSettings
Returns the global system settings.
GetTableUserFields
Returns the fields that belong to a table.
GetTotalSubnetAndIPAddressCounts
Returns the total number of active subnets and IP addresses in the database.
GetUserDisabledFunctions
Returns a list of user functions that are not available to the current user.
GetUserInformation
Returns information about the current user.
GetUserMessages
Returns a list of unread user messages.
GetUserPrivileges
Returns the privileges assigned to the current user.
GetUserTables
Returns a list of accessible database tables and their associated fields.
GetVirtualDirectories
Returns a list of virtual directories.
GetVirtualFileData
Returns the file data associated with a virtual file.
GetVirtualFiles
Returns a list of virtual files.
GetWebClientSettings
Returns the web client settings.
LinkedIPDescriptionExists
Returns true if a linked IP address description exists.
MoveVirtualDirectory
Moves a virtual server directory to a new location.
MoveVirtualFile
Moves a virtual server file to a new location.
RenameVirtualDirectory
Renames a virtual server directory.
RenameVirtualFile
Renames a virtual server file.
SearchARPEntries
Searches for matching ARP entries, returning the result in a binary format.
SearchARPEntries2
Searches for matching ARP entries, returning the result as simple data.
SearchDatabaseNative
Searches the Subnet and IP address tables using a native database method. The results are returned in a binary format.
SearchDatabaseNative2
Searches the Subnet and IP address tables using a native database method. The results are returned as simple data.
SearchDatabaseFTS
Searches the Subnet and IP address tables using the Full Text Search index. The results are returned in a binary format.
SearchDatabaseFTS2
Searches the Subnet and IP address tables using the Full Text Search index. The results are returned as simple data.
SearchItems
Returns an array of groups/subnets that start with the search text.
SendEmail
Adds an email to the send queue.
SetClientSettings
Sets the settings of the current client.
SetVirtualFileReadOnly
Sets the read only flag of a virtual file.
SetWebClientSettings
Sets the web client settings of the current user.
VirtualDirectoryExists
Returns true if a virtual directory exists.
VirtualFileExists
Returns true if a virtual file exists.

Method AddOrUpdateVirtualFile

Adds or updates a virtual server file.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file path.

The UserDir macro will be expanded to the current user's virtual home directory.
In FileData Binary
The binary file data you want to save.
In FileDataLinkId Int64
Instead of adding the file data, you can link to another virtual file that contains data. To do this, set this parameter to the ID of the virtual file you want to link to.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.AddOrUpdateVirtualFile(const FilenameAndPath: Widestring ; const FileData: Binary ; const FileDataLinkId: Int64);

C# Syntax:

public void EasyIPCore.AddOrUpdateVirtualFile( String FilenameAndPath , Binary FileData , Int64 FileDataLinkId);

Delphi Syntax:

procedure EasyIPCore.AddOrUpdateVirtualFile(const FilenameAndPath: Widestring ; const FileData: Binary ; const FileDataLinkId: Int64) ;

Method AddVirtualDirectory

Adds a virtual server directory.

Parameters:

Flag Name Type Description
In DirectoryPath Widestring
The virtual directory path to add.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPCore.AddVirtualDirectory(const DirectoryPath: Widestring) : Int64;

C# Syntax:

public Int64 EasyIPCore.AddVirtualDirectory( String DirectoryPath);

Delphi Syntax:

function EasyIPCore.AddVirtualDirectory(const DirectoryPath: Widestring) : Int64;

Method CancelOperation

Cancels the asynchronous operation specified by the operation ID.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.CancelOperation(const OperationId: Widestring);

C# Syntax:

public void EasyIPCore.CancelOperation( String OperationId);

Delphi Syntax:

procedure EasyIPCore.CancelOperation(const OperationId: Widestring) ;

Method CheckUserFunctionAllowed

Checks to see if a user function if allowed.

Parameters:

Flag Name Type Description
In UserFunction WideString
A textual description of the user function.
In RaiseException Boolean
If true, an exception will be raised if the user is denied access to the function. If false, the function will return true or false depending on the result.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPCore.CheckUserFunctionAllowed(const UserFunction: WideString ; const RaiseException: Boolean) : Boolean;

C# Syntax:

public Boolean EasyIPCore.CheckUserFunctionAllowed(WideString UserFunction , Boolean RaiseException);

Delphi Syntax:

function EasyIPCore.CheckUserFunctionAllowed(const UserFunction: WideString ; const RaiseException: Boolean) : Boolean;

Method CopyVirtualDirectoryContents

Copies the contents of one virtual server directory to another.

Parameters:

Flag Name Type Description
In SourceDirectory Widestring
The source virtual directory.

The UserDir macro will be expanded to the current user's virtual home directory.
In DestinationDirectory Widestring
The destination virtual directory.

The UserDir macro will be expanded to the current user's virtual home directory.
In CopyAsShorcutLinks Boolean
If true, the virtual server files will be copied as links (shortcuts).

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.CopyVirtualDirectoryContents(const SourceDirectory: Widestring ; const DestinationDirectory: Widestring ; const CopyAsShorcutLinks: Boolean);

C# Syntax:

public void EasyIPCore.CopyVirtualDirectoryContents( String SourceDirectory , String DestinationDirectory , Boolean CopyAsShorcutLinks);

Delphi Syntax:

procedure EasyIPCore.CopyVirtualDirectoryContents(const SourceDirectory: Widestring ; const DestinationDirectory: Widestring ; const CopyAsShorcutLinks: Boolean) ;

Method DeleteDownloadFile

Deletes a server file that has been downloaded to a client. A server file is not the same as a virtual server file. A virtual server file is stored in the database. A server file is generated by the server and stored in the local file system ready to be downloaded by a user.

Parameters:

Flag Name Type Description
In FileId WideString
The ID of the file you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.DeleteDownloadFile(const FileId: WideString);

C# Syntax:

public void EasyIPCore.DeleteDownloadFile(WideString FileId);

Delphi Syntax:

procedure EasyIPCore.DeleteDownloadFile(const FileId: WideString) ;

Method DeleteVirtualDirectory

Deletes a virtual server directory.

Parameters:

Flag Name Type Description
In DirectoryPath Widestring
The virtual directory path to delete.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.DeleteVirtualDirectory(const DirectoryPath: Widestring);

C# Syntax:

public void EasyIPCore.DeleteVirtualDirectory( String DirectoryPath);

Delphi Syntax:

procedure EasyIPCore.DeleteVirtualDirectory(const DirectoryPath: Widestring) ;

Method DeleteVirtualFile

Deletes a virtual server file.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file you want to delete.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.DeleteVirtualFile(const FilenameAndPath: Widestring);

C# Syntax:

public void EasyIPCore.DeleteVirtualFile( String FilenameAndPath);

Delphi Syntax:

procedure EasyIPCore.DeleteVirtualFile(const FilenameAndPath: Widestring) ;

Method GetAddressData

Returns the IP address data in a binary format.

Parameters:

Flag Name Type Description
In SubnetId Int64
The ID of the subnet whose IP Address data you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetAddressData(const SubnetId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : Binary;

C# Syntax:

public Binary EasyIPCore.GetAddressData(Int64 SubnetId , Int32 RecordSkip , Int32 RecordCount , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetAddressData(const SubnetId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : Binary;

Method GetAddressData2

Returns the IP address records as simple data.

Parameters:

Flag Name Type Description
In SubnetId Int64
The ID of the subnet whose IP Address data you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetAddressData2(const SubnetId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetAddressData2(Int64 SubnetId , Int32 RecordSkip , Int32 RecordCount , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetAddressData2(const SubnetId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : TSimpleData;

Method GetAutonomousNetworkNameFromId

Returns the name of an autonomous network given it's ID.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPCore.GetAutonomousNetworkNameFromId(const AutonomousNetworkId: Int64) : WideString;

C# Syntax:

public WideString EasyIPCore.GetAutonomousNetworkNameFromId(Int64 AutonomousNetworkId);

Delphi Syntax:

function EasyIPCore.GetAutonomousNetworkNameFromId(const AutonomousNetworkId: Int64) : WideString;

Method GetAutonomousNetworkNotes

Returns the notes of an autonomous network given it's ID.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPCore.GetAutonomousNetworkNotes(const AutonomousNetworkId: Int64) : WideString;

C# Syntax:

public WideString EasyIPCore.GetAutonomousNetworkNotes(Int64 AutonomousNetworkId);

Delphi Syntax:

function EasyIPCore.GetAutonomousNetworkNotes(const AutonomousNetworkId: Int64) : WideString;

Method GetAutonomousNetworks

Returns the autonomous networks available to the current user in a binary format.

Parameters:

Flag Name Type Description
In GetAll Boolean
If true, all the autonomous networks are returned. This requires Administrator or Super Administrator privileges.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetAutonomousNetworks(const GetAll: Boolean) : Binary;

C# Syntax:

public Binary EasyIPCore.GetAutonomousNetworks(Boolean GetAll);

Delphi Syntax:

function EasyIPCore.GetAutonomousNetworks(const GetAll: Boolean) : Binary;

Method GetAutonomousNetworks2

Returns the autonomous networks available to the current user as simple data.

Parameters:

Flag Name Type Description
In GetAll Boolean
If true, all the autonomous networks are returned. This requires Administrator or Super Administrator privileges.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetAutonomousNetworks2(const GetAll: Boolean) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetAutonomousNetworks2(Boolean GetAll);

Delphi Syntax:

function EasyIPCore.GetAutonomousNetworks2(const GetAll: Boolean) : TSimpleData;

Method GetChangeLogEntries

Returns an array of change log entries.

Parameters:

Flag Name Type Description
In TableName Widestring
The name of the table.
In RecordId Int64
The ID of the record whose change log data you want to retrieve.

Return Value:

Flag Name Type
Result Result TChangeLogItems

Oxygene Syntax:

method EasyIPCore.GetChangeLogEntries(const TableName: Widestring ; const RecordId: Int64) : TChangeLogItems;

C# Syntax:

public TChangeLogItems EasyIPCore.GetChangeLogEntries( String TableName , Int64 RecordId);

Delphi Syntax:

function EasyIPCore.GetChangeLogEntries(const TableName: Widestring ; const RecordId: Int64) : TChangeLogItems;

Method GetChangeLogRevisions

Returns an array of revisions associated with a change log.

Parameters:

Flag Name Type Description
In ChangeLogId Int64
The ID of the change log entry whose revisions you want to retrieve.

Return Value:

Flag Name Type
Result Result TChangeLogEntries

Oxygene Syntax:

method EasyIPCore.GetChangeLogRevisions(const ChangeLogId: Int64) : TChangeLogEntries;

C# Syntax:

public TChangeLogEntries EasyIPCore.GetChangeLogRevisions(Int64 ChangeLogId);

Delphi Syntax:

function EasyIPCore.GetChangeLogRevisions(const ChangeLogId: Int64) : TChangeLogEntries;

Method GetChildNodes

Returns the child nodes of an item in a binary format. User data is not included.

Parameters:

Flag Name Type Description
In ParentId Int64
The ID of the parent item.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetChildNodes(const ParentId: Int64) : Binary;

C# Syntax:

public Binary EasyIPCore.GetChildNodes(Int64 ParentId);

Delphi Syntax:

function EasyIPCore.GetChildNodes(const ParentId: Int64) : Binary;

Method GetChildNodes2

Returns the child nodes of an item as simple data. User data is not included.

Parameters:

Flag Name Type Description
In ParentId Int64

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetChildNodes2(const ParentId: Int64) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetChildNodes2(Int64 ParentId);

Delphi Syntax:

function EasyIPCore.GetChildNodes2(const ParentId: Int64) : TSimpleData;

Method GetClientSettings

Returns the current user settings.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TClientSettings

Oxygene Syntax:

method EasyIPCore.GetClientSettings() : TClientSettings;

C# Syntax:

public TClientSettings EasyIPCore.GetClientSettings();

Delphi Syntax:

function EasyIPCore.GetClientSettings() : TClientSettings;

Method GetDownloadFilePart

Returns a portion of a server file.

Parameters:

Flag Name Type Description
In FileId WideString
The ID of the server file you want to download.
In FilePartNo Int64
The part number.
In FilePartSize Int64
The size of the part.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetDownloadFilePart(const FileId: WideString ; const FilePartNo: Int64 ; const FilePartSize: Int64) : Binary;

C# Syntax:

public Binary EasyIPCore.GetDownloadFilePart(WideString FileId , Int64 FilePartNo , Int64 FilePartSize);

Delphi Syntax:

function EasyIPCore.GetDownloadFilePart(const FileId: WideString ; const FilePartNo: Int64 ; const FilePartSize: Int64) : Binary;

Method GetDownloadFileSize

Returns the size of a server file.

Parameters:

Flag Name Type Description
In FileId WideString
The ID of the server file.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPCore.GetDownloadFileSize(const FileId: WideString) : Int64;

C# Syntax:

public Int64 EasyIPCore.GetDownloadFileSize(WideString FileId);

Delphi Syntax:

function EasyIPCore.GetDownloadFileSize(const FileId: WideString) : Int64;

Method GetEasyIPUser

Returns information about the current Easy-IP user.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TEasyIPUser

Oxygene Syntax:

method EasyIPCore.GetEasyIPUser() : TEasyIPUser;

C# Syntax:

public TEasyIPUser EasyIPCore.GetEasyIPUser();

Delphi Syntax:

function EasyIPCore.GetEasyIPUser() : TEasyIPUser;

Method GetFullTextSearchProgress

Returns information about the status of Full Text Search indexing.

Parameters:

Flag Name Type Description
Out Pending Int64

Out Total Int64

Out IndexesPerMinute Int64

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.GetFullTextSearchProgress(Pending: Int64 ; Total: Int64 ; IndexesPerMinute: Int64);

C# Syntax:

public void EasyIPCore.GetFullTextSearchProgress(out Int64 Pending , out Int64 Total , out Int64 IndexesPerMinute);

Delphi Syntax:

procedure EasyIPCore.GetFullTextSearchProgress(Pending: Int64 ; Total: Int64 ; IndexesPerMinute: Int64) ;

Method GetIPAddressesBySubnet

Returns a list of IP addresses that exist in a subnet in a binary format.

Parameters:

Flag Name Type Description
In SubnetId Int64
The ID of the subnet whose IP addresses you want to return.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetIPAddressesBySubnet(const SubnetId: Int64) : Binary;

C# Syntax:

public Binary EasyIPCore.GetIPAddressesBySubnet(Int64 SubnetId);

Delphi Syntax:

function EasyIPCore.GetIPAddressesBySubnet(const SubnetId: Int64) : Binary;

Method GetIPAddressesBySubnet2

Returns a list of IP addresses that exist in a subnet as simple data.

Parameters:

Flag Name Type Description
In SubnetId Int64

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetIPAddressesBySubnet2(const SubnetId: Int64) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetIPAddressesBySubnet2(Int64 SubnetId);

Delphi Syntax:

function EasyIPCore.GetIPAddressesBySubnet2(const SubnetId: Int64) : TSimpleData;

Method GetIPAddressIdAndSubnetId

Returns the subnet ID and IP address ID given the autonomous network ID and IP address.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network.
In IPAddress WideString
The IP address.
Out SubnetId Int64
The returned subnet ID.
Out IPAddressId Int64
The returned IP address ID.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPCore.GetIPAddressIdAndSubnetId(const AutonomousNetworkId: Int64 ; const IPAddress: WideString ; SubnetId: Int64 ; IPAddressId: Int64) : Boolean;

C# Syntax:

public Boolean EasyIPCore.GetIPAddressIdAndSubnetId(Int64 AutonomousNetworkId , WideString IPAddress , out Int64 SubnetId , out Int64 IPAddressId);

Delphi Syntax:

function EasyIPCore.GetIPAddressIdAndSubnetId(const AutonomousNetworkId: Int64 ; const IPAddress: WideString ; SubnetId: Int64 ; IPAddressId: Int64) : Boolean;

Method GetItemData

Returns the child groups/subnets in a binary format.

Parameters:

Flag Name Type Description
In ItemId Int64
The ID of the Group or Subnet whose children you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
In AllChildSubnets Boolean
If true, all the children of the subnet will be returned. This includes children of children etc.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetItemData(const ItemId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; const AllChildSubnets: Boolean ; Information: WideString) : Binary;

C# Syntax:

public Binary EasyIPCore.GetItemData(Int64 ItemId , Int32 RecordSkip , Int32 RecordCount , Boolean AllChildSubnets , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetItemData(const ItemId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; const AllChildSubnets: Boolean ; Information: WideString) : Binary;

Method GetItemData2

Returns the child groups/subnets as simple data.

Parameters:

Flag Name Type Description
In ItemId Int64
The ID of the Group or Subnet whose children you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
In AllChildSubnets Boolean
If true, all the children of the subnet will be returned. This includes children of children etc.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetItemData2(const ItemId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; const AllChildSubnets: Boolean ; Information: WideString) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetItemData2(Int64 ItemId , Int32 RecordSkip , Int32 RecordCount , Boolean AllChildSubnets , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetItemData2(const ItemId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; const AllChildSubnets: Boolean ; Information: WideString) : TSimpleData;

Method GetItemRangeLimits

Returns the IP address range limits for a group or subnet.

Parameters:

Flag Name Type Description
In Id Int64
The ID of the group or subnet.
Out IPVersion TIPVers
The returned IP version of the range.
Out LowIPAddress Widestring
The returned low IP address of the range.
Out HighIPAddress Widestring
The returned high IP address of the range.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.GetItemRangeLimits(const Id: Int64 ; IPVersion: TIPVers ; LowIPAddress: Widestring ; HighIPAddress: Widestring);

C# Syntax:

public void EasyIPCore.GetItemRangeLimits(Int64 Id , out TIPVers IPVersion , out String LowIPAddress , out String HighIPAddress);

Delphi Syntax:

procedure EasyIPCore.GetItemRangeLimits(const Id: Int64 ; IPVersion: TIPVers ; LowIPAddress: Widestring ; HighIPAddress: Widestring) ;

Method GetLastUndoItem

Returns the last undo item for the current user.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TUndoItem

Oxygene Syntax:

method EasyIPCore.GetLastUndoItem() : TUndoItem;

C# Syntax:

public TUndoItem EasyIPCore.GetLastUndoItem();

Delphi Syntax:

function EasyIPCore.GetLastUndoItem() : TUndoItem;

Method GetLicenceDetails

Returns information about the Easy-IP licence.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPCore.GetLicenceDetails() : TStringArray;

C# Syntax:

public TStringArray EasyIPCore.GetLicenceDetails();

Delphi Syntax:

function EasyIPCore.GetLicenceDetails() : TStringArray;

Method GetLinkedIPAddressDescriptions

Returns a list of Linked IP address descriptions.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TLinkedIPAddressDescriptions

Oxygene Syntax:

method EasyIPCore.GetLinkedIPAddressDescriptions() : TLinkedIPAddressDescriptions;

C# Syntax:

public TLinkedIPAddressDescriptions EasyIPCore.GetLinkedIPAddressDescriptions();

Delphi Syntax:

function EasyIPCore.GetLinkedIPAddressDescriptions() : TLinkedIPAddressDescriptions;

Method GetLinkedIPAddresses

Returns an array of IP addresses that are linked to the specified IP address.

Parameters:

Flag Name Type Description
In IPAddressID Int64
The ID of the IP address.

Return Value:

Flag Name Type
Result Result TLinkedIPAddresses

Oxygene Syntax:

method EasyIPCore.GetLinkedIPAddresses(const IPAddressID: Int64) : TLinkedIPAddresses;

C# Syntax:

public TLinkedIPAddresses EasyIPCore.GetLinkedIPAddresses(Int64 IPAddressID);

Delphi Syntax:

function EasyIPCore.GetLinkedIPAddresses(const IPAddressID: Int64) : TLinkedIPAddresses;

Method GetLongSubnetPathFromSubnetId

Returns a descriptive path given a group or subnet ID.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network.
In ItemId Int64
The ID of the group or subnet.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPCore.GetLongSubnetPathFromSubnetId(const AutonomousNetworkId: Int64 ; const ItemId: Int64) : WideString;

C# Syntax:

public WideString EasyIPCore.GetLongSubnetPathFromSubnetId(Int64 AutonomousNetworkId , Int64 ItemId);

Delphi Syntax:

function EasyIPCore.GetLongSubnetPathFromSubnetId(const AutonomousNetworkId: Int64 ; const ItemId: Int64) : WideString;

Method GetPingHistory

Returns the ping history of a specific IP address.

Parameters:

Flag Name Type Description
In AddressID Int64
The ID of the IP address.

Return Value:

Flag Name Type
Result Result TPingHistoryResult

Oxygene Syntax:

method EasyIPCore.GetPingHistory(const AddressID: Int64) : TPingHistoryResult;

C# Syntax:

public TPingHistoryResult EasyIPCore.GetPingHistory(Int64 AddressID);

Delphi Syntax:

function EasyIPCore.GetPingHistory(const AddressID: Int64) : TPingHistoryResult;

Method GetRootData

Returns the root groups/subnets of an autonomous network in binary format.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the Autonomous Network whose root groups/subnets you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetRootData(const AutonomousNetworkId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : Binary;

C# Syntax:

public Binary EasyIPCore.GetRootData(Int64 AutonomousNetworkId , Int32 RecordSkip , Int32 RecordCount , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetRootData(const AutonomousNetworkId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : Binary;

Method GetRootData2

Returns the root groups/subnets of an autonomous network as simple data.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the Autonomous Network whose root groups/subnets you want to retrieve.
In RecordSkip Integer
The number of records to skip before starting to return data.
In RecordCount Integer
The number of records to return.
Out Information WideString
Information about the records that are retrieved.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetRootData2(const AutonomousNetworkId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetRootData2(Int64 AutonomousNetworkId , Int32 RecordSkip , Int32 RecordCount , out WideString Information);

Delphi Syntax:

function EasyIPCore.GetRootData2(const AutonomousNetworkId: Int64 ; const RecordSkip: Integer ; const RecordCount: Integer ; Information: WideString) : TSimpleData;

Method GetRootNodes

Returns the root nodes of an autonomous network in a binary format. No user data is included.

Parameters:

Flag Name Type Description
In AutonomousNetworkID Int64
The ID of the autonomous network.
In GetAll Boolean
When true, all the child nodes will be returned including children of children etc.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetRootNodes(const AutonomousNetworkID: Int64 ; const GetAll: Boolean) : Binary;

C# Syntax:

public Binary EasyIPCore.GetRootNodes(Int64 AutonomousNetworkID , Boolean GetAll);

Delphi Syntax:

function EasyIPCore.GetRootNodes(const AutonomousNetworkID: Int64 ; const GetAll: Boolean) : Binary;

Method GetRootNodes2

Returns the root nodes of an autonomous network as simple data. No user data is included.

Parameters:

Flag Name Type Description
In AutonomousNetworkID Int64
The ID of the autonomous network.
In GetAll Boolean
When true, all the child nodes will be returned including children of children etc.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetRootNodes2(const AutonomousNetworkID: Int64 ; const GetAll: Boolean) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetRootNodes2(Int64 AutonomousNetworkID , Boolean GetAll);

Delphi Syntax:

function EasyIPCore.GetRootNodes2(const AutonomousNetworkID: Int64 ; const GetAll: Boolean) : TSimpleData;

Method GetItemById

Returns group or subnet data in a binary format.

Parameters:

Flag Name Type Description
In ItemID Int64
The ID of the group or subnet.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetItemById(const ItemID: Int64) : Binary;

C# Syntax:

public Binary EasyIPCore.GetItemById(Int64 ItemID);

Delphi Syntax:

function EasyIPCore.GetItemById(const ItemID: Int64) : Binary;

Method GetItemById2

Returns group or subnet data as simple data.

Parameters:

Flag Name Type Description
In ItemID Int64

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetItemById2(const ItemID: Int64) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetItemById2(Int64 ItemID);

Delphi Syntax:

function EasyIPCore.GetItemById2(const ItemID: Int64) : TSimpleData;

Method GetItemByInfo

Returns group or subnet data in a binary format.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network.
In ItemName Widestring
The name of the group or subnet.
In CidrMask Integer
The cidr mask of the item (0 if the item is a group).

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetItemByInfo(const AutonomousNetworkId: Int64 ; const ItemName: Widestring ; const CidrMask: Integer) : Binary;

C# Syntax:

public Binary EasyIPCore.GetItemByInfo(Int64 AutonomousNetworkId , String ItemName , Int32 CidrMask);

Delphi Syntax:

function EasyIPCore.GetItemByInfo(const AutonomousNetworkId: Int64 ; const ItemName: Widestring ; const CidrMask: Integer) : Binary;

Method GetItemByInfo2

Returns group or subnet data as simple data.

Parameters:

Flag Name Type Description
In AutonomousNetworkID Int64
The ID of the autonomous network.
In ItemName WideString
The name of the group or subnet.
In CidrMask Integer
The cidr mask of the item (0 if the item is a group).

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.GetItemByInfo2(const AutonomousNetworkID: Int64 ; const ItemName: WideString ; const CidrMask: Integer) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.GetItemByInfo2(Int64 AutonomousNetworkID , WideString ItemName , Int32 CidrMask);

Delphi Syntax:

function EasyIPCore.GetItemByInfo2(const AutonomousNetworkID: Int64 ; const ItemName: WideString ; const CidrMask: Integer) : TSimpleData;

Method GetItemParentIds

Returns the parent IDs of a group or subnet.

Parameters:

Flag Name Type Description
In ItemId Int64
The ID of the group or subnet.
In IncludeThisSubnet Boolean
If true, the ID of the group or subnet will be added to the result.

Return Value:

Flag Name Type
Result Result TInt64Array

Oxygene Syntax:

method EasyIPCore.GetItemParentIds(const ItemId: Int64 ; const IncludeThisSubnet: Boolean) : TInt64Array;

C# Syntax:

public TInt64Array EasyIPCore.GetItemParentIds(Int64 ItemId , Boolean IncludeThisSubnet);

Delphi Syntax:

function EasyIPCore.GetItemParentIds(const ItemId: Int64 ; const IncludeThisSubnet: Boolean) : TInt64Array;

Method GetSystemSettings

Returns the global system settings.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TSystemSettings

Oxygene Syntax:

method EasyIPCore.GetSystemSettings() : TSystemSettings;

C# Syntax:

public TSystemSettings EasyIPCore.GetSystemSettings();

Delphi Syntax:

function EasyIPCore.GetSystemSettings() : TSystemSettings;

Method GetTableUserFields

Returns the fields that belong to a table.

Parameters:

Flag Name Type Description
In TableName Widestring
The name of the table.

Return Value:

Flag Name Type
Result Result TUserFields

Oxygene Syntax:

method EasyIPCore.GetTableUserFields(const TableName: Widestring) : TUserFields;

C# Syntax:

public TUserFields EasyIPCore.GetTableUserFields( String TableName);

Delphi Syntax:

function EasyIPCore.GetTableUserFields(const TableName: Widestring) : TUserFields;

Method GetTotalSubnetAndIPAddressCounts

Returns the total number of active subnets and IP addresses in the database.

Parameters:

Flag Name Type Description
Out SubnetCount Int64
The subnet count result.
Out IPAddressCount Int64
The IP address count result.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.GetTotalSubnetAndIPAddressCounts(SubnetCount: Int64 ; IPAddressCount: Int64);

C# Syntax:

public void EasyIPCore.GetTotalSubnetAndIPAddressCounts(out Int64 SubnetCount , out Int64 IPAddressCount);

Delphi Syntax:

procedure EasyIPCore.GetTotalSubnetAndIPAddressCounts(SubnetCount: Int64 ; IPAddressCount: Int64) ;

Method GetUserDisabledFunctions

Returns a list of user functions that are not available to the current user.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPCore.GetUserDisabledFunctions() : TStringArray;

C# Syntax:

public TStringArray EasyIPCore.GetUserDisabledFunctions();

Delphi Syntax:

function EasyIPCore.GetUserDisabledFunctions() : TStringArray;

Method GetUserInformation

Returns information about the current user.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TUserInformation

Oxygene Syntax:

method EasyIPCore.GetUserInformation() : TUserInformation;

C# Syntax:

public TUserInformation EasyIPCore.GetUserInformation();

Delphi Syntax:

function EasyIPCore.GetUserInformation() : TUserInformation;

Method GetUserMessages

Returns a list of unread user messages.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TUserInfoMessages

Oxygene Syntax:

method EasyIPCore.GetUserMessages() : TUserInfoMessages;

C# Syntax:

public TUserInfoMessages EasyIPCore.GetUserMessages();

Delphi Syntax:

function EasyIPCore.GetUserMessages() : TUserInfoMessages;

Method GetUserPrivileges

Returns the privileges assigned to the current user.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TUserPrivileges

Oxygene Syntax:

method EasyIPCore.GetUserPrivileges() : TUserPrivileges;

C# Syntax:

public TUserPrivileges EasyIPCore.GetUserPrivileges();

Delphi Syntax:

function EasyIPCore.GetUserPrivileges() : TUserPrivileges;

Method GetUserTables

Returns a list of accessible database tables and their associated fields.

Parameters:

Flag Name Type Description
In IncludeChildTables Boolean
If true, linked tables will be included. e.g. SUBNETs_USER_DATA, ADDRESSES_USER_DATA
In IncludeLookups Boolean
If true, the values of lookup lists will be included.

Return Value:

Flag Name Type
Result Result TUserTables

Oxygene Syntax:

method EasyIPCore.GetUserTables(const IncludeChildTables: Boolean ; const IncludeLookups: Boolean) : TUserTables;

C# Syntax:

public TUserTables EasyIPCore.GetUserTables(Boolean IncludeChildTables , Boolean IncludeLookups);

Delphi Syntax:

function EasyIPCore.GetUserTables(const IncludeChildTables: Boolean ; const IncludeLookups: Boolean) : TUserTables;

Method GetVirtualDirectories

Returns a list of virtual directories.

Parameters:

Flag Name Type Description
In ParentDirectory Widestring
The virtual parent directory.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

Flag Name Type
Result Result TVirtualDirectories

Oxygene Syntax:

method EasyIPCore.GetVirtualDirectories(const ParentDirectory: Widestring) : TVirtualDirectories;

C# Syntax:

public TVirtualDirectories EasyIPCore.GetVirtualDirectories( String ParentDirectory);

Delphi Syntax:

function EasyIPCore.GetVirtualDirectories(const ParentDirectory: Widestring) : TVirtualDirectories;

Method GetVirtualFileData

Returns the file data associated with a virtual file.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file path.

The UserDir macro will be expanded to the current user's virtual home directory.
In LocalFileDate DateTime
The file date of the locally cached file.
Out VirtualFileDate DateTime
Returns the file data of the virtual server file.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.GetVirtualFileData(const FilenameAndPath: Widestring ; const LocalFileDate: DateTime ; VirtualFileDate: DateTime) : Binary;

C# Syntax:

public Binary EasyIPCore.GetVirtualFileData( String FilenameAndPath , DateTime LocalFileDate , out DateTime VirtualFileDate);

Delphi Syntax:

function EasyIPCore.GetVirtualFileData(const FilenameAndPath: Widestring ; const LocalFileDate: DateTime ; VirtualFileDate: DateTime) : Binary;

Method GetVirtualFiles

Returns a list of virtual files.

Parameters:

Flag Name Type Description
In ParentDirectory Widestring
The virtual parent directory.

The UserDir macro will be expanded to the current user's virtual home directory.
In FileType Widestring
Specified the file type to return.

Return Value:

Flag Name Type
Result Result TVirtualFiles

Oxygene Syntax:

method EasyIPCore.GetVirtualFiles(const ParentDirectory: Widestring ; const FileType: Widestring) : TVirtualFiles;

C# Syntax:

public TVirtualFiles EasyIPCore.GetVirtualFiles( String ParentDirectory , String FileType);

Delphi Syntax:

function EasyIPCore.GetVirtualFiles(const ParentDirectory: Widestring ; const FileType: Widestring) : TVirtualFiles;

Method GetWebClientSettings

Returns the web client settings.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TWebClientSettings

Oxygene Syntax:

method EasyIPCore.GetWebClientSettings() : TWebClientSettings;

C# Syntax:

public TWebClientSettings EasyIPCore.GetWebClientSettings();

Delphi Syntax:

function EasyIPCore.GetWebClientSettings() : TWebClientSettings;

Method LinkedIPDescriptionExists

Returns true if a linked IP address description exists.

Parameters:

Flag Name Type Description
In Description WideString
The linked IP address description.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPCore.LinkedIPDescriptionExists(const Description: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPCore.LinkedIPDescriptionExists(WideString Description);

Delphi Syntax:

function EasyIPCore.LinkedIPDescriptionExists(const Description: WideString) : Boolean;

Method MoveVirtualDirectory

Moves a virtual server directory to a new location.

Parameters:

Flag Name Type Description
In DirectoryPath Widestring
The source virtual directory path.

The UserDir macro will be expanded to the current user's virtual home directory.
In NewPath Widestring
The destination virtual directory path.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.MoveVirtualDirectory(const DirectoryPath: Widestring ; const NewPath: Widestring);

C# Syntax:

public void EasyIPCore.MoveVirtualDirectory( String DirectoryPath , String NewPath);

Delphi Syntax:

procedure EasyIPCore.MoveVirtualDirectory(const DirectoryPath: Widestring ; const NewPath: Widestring) ;

Method MoveVirtualFile

Moves a virtual server file to a new location.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file path.

The UserDir macro will be expanded to the current user's virtual home directory.
In NewPath Widestring
The new file path.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.MoveVirtualFile(const FilenameAndPath: Widestring ; const NewPath: Widestring);

C# Syntax:

public void EasyIPCore.MoveVirtualFile( String FilenameAndPath , String NewPath);

Delphi Syntax:

procedure EasyIPCore.MoveVirtualFile(const FilenameAndPath: Widestring ; const NewPath: Widestring) ;

Method RenameVirtualDirectory

Renames a virtual server directory.

Parameters:

Flag Name Type Description
In DirectoryPath Widestring
The virtual directory path.

The UserDir macro will be expanded to the current user's virtual home directory.
In NewName Widestring
The new name for the virtual directory.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.RenameVirtualDirectory(const DirectoryPath: Widestring ; const NewName: Widestring);

C# Syntax:

public void EasyIPCore.RenameVirtualDirectory( String DirectoryPath , String NewName);

Delphi Syntax:

procedure EasyIPCore.RenameVirtualDirectory(const DirectoryPath: Widestring ; const NewName: Widestring) ;

Method RenameVirtualFile

Renames a virtual server file.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file path.

The UserDir macro will be expanded to the current user's virtual home directory.
In NewName Widestring
The new name for the virtual file.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.RenameVirtualFile(const FilenameAndPath: Widestring ; const NewName: Widestring);

C# Syntax:

public void EasyIPCore.RenameVirtualFile( String FilenameAndPath , String NewName);

Delphi Syntax:

procedure EasyIPCore.RenameVirtualFile(const FilenameAndPath: Widestring ; const NewName: Widestring) ;

Method SearchARPEntries

Searches for matching ARP entries, returning the result in a binary format.

Parameters:

Flag Name Type Description
In SearchText WideString
The search text.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.SearchARPEntries(const SearchText: WideString) : Binary;

C# Syntax:

public Binary EasyIPCore.SearchARPEntries(WideString SearchText);

Delphi Syntax:

function EasyIPCore.SearchARPEntries(const SearchText: WideString) : Binary;

Method SearchARPEntries2

Searches for matching ARP entries, returning the result as simple data.

Parameters:

Flag Name Type Description
In SearchText WideString
The search text.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.SearchARPEntries2(const SearchText: WideString) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.SearchARPEntries2(WideString SearchText);

Delphi Syntax:

function EasyIPCore.SearchARPEntries2(const SearchText: WideString) : TSimpleData;

Method SearchDatabaseNative

Searches the Subnet and IP address tables using a native database method. The results are returned in a binary format.

Parameters:

Flag Name Type Description
In TableId Integer
The ID of the table you want to search.
In FieldIds TInt64Array
The IDs of the fields you want to search. If this parameter is nil or contains no items, all the fields will be searched.
In SearchText WideString
The text that you want to search for.
In SearchOption TSearchOption
The options to use to perform the search.
Out Information WideString
Returns information about the search.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.SearchDatabaseNative(const TableId: Integer ; const FieldIds: TInt64Array ; const SearchText: WideString ; const SearchOption: TSearchOption ; Information: WideString) : Binary;

C# Syntax:

public Binary EasyIPCore.SearchDatabaseNative( Int32 TableId , TInt64Array FieldIds , WideString SearchText , TSearchOption SearchOption , out WideString Information);

Delphi Syntax:

function EasyIPCore.SearchDatabaseNative(const TableId: Integer ; const FieldIds: TInt64Array ; const SearchText: WideString ; const SearchOption: TSearchOption ; Information: WideString) : Binary;

Method SearchDatabaseNative2

Searches the Subnet and IP address tables using a native database method. The results are returned as simple data.

Parameters:

Flag Name Type Description
In TableId Integer
The ID of the table you want to search.
In FieldIds TInt64Array
The IDs of the fields you want to search. If this parameter is nil or contains no items, all the fields will be searched.
In SearchText WideString
The text that you want to search for.
In SearchOption TSearchOption
The options to use to perform the search.
Out Information WideString
Returns information about the search.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.SearchDatabaseNative2(const TableId: Integer ; const FieldIds: TInt64Array ; const SearchText: WideString ; const SearchOption: TSearchOption ; Information: WideString) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.SearchDatabaseNative2( Int32 TableId , TInt64Array FieldIds , WideString SearchText , TSearchOption SearchOption , out WideString Information);

Delphi Syntax:

function EasyIPCore.SearchDatabaseNative2(const TableId: Integer ; const FieldIds: TInt64Array ; const SearchText: WideString ; const SearchOption: TSearchOption ; Information: WideString) : TSimpleData;

Method SearchDatabaseFTS

Searches the Subnet and IP address tables using the Full Text Search index. The results are returned in a binary format.

Parameters:

Flag Name Type Description
In TableId Integer
The ID of the table you want to search.
In FieldId Integer

In SearchText WideString
The text that you want to search for.
In ExactMatchesOnly Boolean
If true, only exact matches are returned. If false, items that begin with the seach text will be included.
Out Indexing Boolean
If true, the database is currently being indexed.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPCore.SearchDatabaseFTS(const TableId: Integer ; const FieldId: Integer ; const SearchText: WideString ; const ExactMatchesOnly: Boolean ; Indexing: Boolean) : Binary;

C# Syntax:

public Binary EasyIPCore.SearchDatabaseFTS( Int32 TableId , Int32 FieldId , WideString SearchText , Boolean ExactMatchesOnly , out Boolean Indexing);

Delphi Syntax:

function EasyIPCore.SearchDatabaseFTS(const TableId: Integer ; const FieldId: Integer ; const SearchText: WideString ; const ExactMatchesOnly: Boolean ; Indexing: Boolean) : Binary;

Method SearchDatabaseFTS2

Searches the Subnet and IP address tables using the Full Text Search index. The results are returned as simple data.

Parameters:

Flag Name Type Description
In TableId Integer
The ID of the table you want to search.
In FieldId Integer

In SearchText WideString
The text that you want to search for.
In ExactMatchesOnly Boolean
If true, only exact matches are returned. If false, items that begin with the seach text will be included.
Out Indexing Boolean
If true, the database is currently being indexed.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPCore.SearchDatabaseFTS2(const TableId: Integer ; const FieldId: Integer ; const SearchText: WideString ; const ExactMatchesOnly: Boolean ; Indexing: Boolean) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPCore.SearchDatabaseFTS2( Int32 TableId , Int32 FieldId , WideString SearchText , Boolean ExactMatchesOnly , out Boolean Indexing);

Delphi Syntax:

function EasyIPCore.SearchDatabaseFTS2(const TableId: Integer ; const FieldId: Integer ; const SearchText: WideString ; const ExactMatchesOnly: Boolean ; Indexing: Boolean) : TSimpleData;

Method SearchItems

Returns an array of groups/subnets that start with the search text.

Parameters:

Flag Name Type Description
In SearchText WideString
The text that you want to search for.
In MaxResults Integer
The maximum number of results to return.

Return Value:

Flag Name Type
Result Result TSubnetsArray

Oxygene Syntax:

method EasyIPCore.SearchItems(const SearchText: WideString ; const MaxResults: Integer) : TSubnetsArray;

C# Syntax:

public TSubnetsArray EasyIPCore.SearchItems(WideString SearchText , Int32 MaxResults);

Delphi Syntax:

function EasyIPCore.SearchItems(const SearchText: WideString ; const MaxResults: Integer) : TSubnetsArray;

Method SendEmail

Adds an email to the send queue.

Parameters:

Flag Name Type Description
In Recipient Widestring
The email recipient.
In CC WideString
The recipient that will be CC'd.
In Subject Widestring
The subject of the email.
In Body Widestring
The email body text.
In AttachmentText WideString
The name of the attachment.
In AttachmentFilename WideString
The name of the server file that you want to attach.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.SendEmail(const Recipient: Widestring ; const CC: WideString ; const Subject: Widestring ; const Body: Widestring ; const AttachmentText: WideString ; const AttachmentFilename: WideString);

C# Syntax:

public void EasyIPCore.SendEmail( String Recipient , WideString CC , String Subject , String Body , WideString AttachmentText , WideString AttachmentFilename);

Delphi Syntax:

procedure EasyIPCore.SendEmail(const Recipient: Widestring ; const CC: WideString ; const Subject: Widestring ; const Body: Widestring ; const AttachmentText: WideString ; const AttachmentFilename: WideString) ;

Method SetClientSettings

Sets the settings of the current client.

Parameters:

Flag Name Type Description
In ClientSettings TClientSettings
The client settings.

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.SetClientSettings(const ClientSettings: TClientSettings);

C# Syntax:

public void EasyIPCore.SetClientSettings(TClientSettings ClientSettings);

Delphi Syntax:

procedure EasyIPCore.SetClientSettings(const ClientSettings: TClientSettings) ;

Method SetVirtualFileReadOnly

Sets the read only flag of a virtual file.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual directory path.

The UserDir macro will be expanded to the current user's virtual home directory.
In ReadOnly Boolean

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.SetVirtualFileReadOnly(const FilenameAndPath: Widestring ; const ReadOnly: Boolean);

C# Syntax:

public void EasyIPCore.SetVirtualFileReadOnly( String FilenameAndPath , Boolean ReadOnly);

Delphi Syntax:

procedure EasyIPCore.SetVirtualFileReadOnly(const FilenameAndPath: Widestring ; const ReadOnly: Boolean) ;

Method SetWebClientSettings

Sets the web client settings of the current user.

Parameters:

Flag Name Type Description
In WebClientSettings TWebClientSettings

Return Value:

None.

Oxygene Syntax:

method EasyIPCore.SetWebClientSettings(const WebClientSettings: TWebClientSettings);

C# Syntax:

public void EasyIPCore.SetWebClientSettings(TWebClientSettings WebClientSettings);

Delphi Syntax:

procedure EasyIPCore.SetWebClientSettings(const WebClientSettings: TWebClientSettings) ;

Method VirtualDirectoryExists

Returns true if a virtual directory exists.

Parameters:

Flag Name Type Description
In DirectoryPath Widestring
The virtual directory path.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPCore.VirtualDirectoryExists(const DirectoryPath: Widestring) : Boolean;

C# Syntax:

public Boolean EasyIPCore.VirtualDirectoryExists( String DirectoryPath);

Delphi Syntax:

function EasyIPCore.VirtualDirectoryExists(const DirectoryPath: Widestring) : Boolean;

Method VirtualFileExists

Returns true if a virtual file exists.

Parameters:

Flag Name Type Description
In FilenameAndPath Widestring
The virtual file path.

The UserDir macro will be expanded to the current user's virtual home directory.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPCore.VirtualFileExists(const FilenameAndPath: Widestring) : Boolean;

C# Syntax:

public Boolean EasyIPCore.VirtualFileExists( String FilenameAndPath);

Delphi Syntax:

function EasyIPCore.VirtualFileExists(const FilenameAndPath: Widestring) : Boolean;
Service LoginService

The following table lists the Operations defined in "LoginService":

AuthenticateDiscoveryBot
Authenticates a Discovery Bot.
AuthenticateDiscoveryBot2
Authenticates a Discovery Bot using a name rather than the bot's IP Address.
ChangePasswordWithOldPassword
Changes a user's password using the old password for authentication. Passwords and usernames are unencrypted.
ChangePasswordWithOldPassword2
Changes a user's password using the old password for authentication. Passwords and usernames are encrypted.
ChangePasswordWithVerificationCode
Changes a user's password using a verification code for authentication. Passwords and usernames are unencrypted.
ChangePasswordWithVerificationCode2
Changes a user's password using a verification code for authentication. Passwords and usernames are encrypted.
DownloadClientInstallerChunk
Deprecated. Use DownloadInstallerChunk.

Downloads a chunk of the client installer for versions previous to 6.1.0.
DownloadIntallerChunk
Downloads a chunk of a client installer.
GetDownloadClientSize
Deprecated. Use GetDownloadSize.

Returns the size of the client installer for versions previous to 6.1.0.
GetDownloadSize
Returns the size of a client installer.
LoggedIn
Returns true is the session is still logged in.
Login
Logs on to the server and creates a new session.
Login2
Logs on to the server using encrypted parameters and creates a new session.
Logout
Logs out of the current session.
ForgottenPassword
Sends a a verification code to a user's registered email address. The verification code can be used to change the password.
RequestUsername
Sends a username to the user's registered email address.

Method AuthenticateDiscoveryBot

Authenticates a Discovery Bot.

Parameters:

Flag Name Type Description
In SharedKeyHash WideString
The hash of the shared key.
In ClientVersion Integer
The client version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In InterfaceVersion Integer
The interface version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In ResetDiscoveries Boolean
Then true, all discoveries associated with the disovery bot will be reset.

Return Value:

Flag Name Type
Result Result TDiscoveryBotSettings

Oxygene Syntax:

method LoginService.AuthenticateDiscoveryBot(const SharedKeyHash: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ResetDiscoveries: Boolean) : TDiscoveryBotSettings;

C# Syntax:

public TDiscoveryBotSettings LoginService.AuthenticateDiscoveryBot(WideString SharedKeyHash , Int32 ClientVersion , Int32 InterfaceVersion , Boolean ResetDiscoveries);

Delphi Syntax:

function LoginService.AuthenticateDiscoveryBot(const SharedKeyHash: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ResetDiscoveries: Boolean) : TDiscoveryBotSettings;

Method AuthenticateDiscoveryBot2

Authenticates a Discovery Bot using a name rather than the bot's IP Address.

Parameters:

Flag Name Type Description
In BotName WideString
The name of the discovery bot.
In SharedKeyHash WideString
The hash of the shared key.
In ClientVersion Integer
The client version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In InterfaceVersion Integer
The interface version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In ResetDiscoveries Boolean
Then true, all discoveries associated with the disovery bot will be reset.

Return Value:

Flag Name Type
Result Result TDiscoveryBotSettings

Oxygene Syntax:

method LoginService.AuthenticateDiscoveryBot2(const BotName: WideString ; const SharedKeyHash: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ResetDiscoveries: Boolean) : TDiscoveryBotSettings;

C# Syntax:

public TDiscoveryBotSettings LoginService.AuthenticateDiscoveryBot2(WideString BotName , WideString SharedKeyHash , Int32 ClientVersion , Int32 InterfaceVersion , Boolean ResetDiscoveries);

Delphi Syntax:

function LoginService.AuthenticateDiscoveryBot2(const BotName: WideString ; const SharedKeyHash: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ResetDiscoveries: Boolean) : TDiscoveryBotSettings;

Method ChangePasswordWithOldPassword

Changes a user's password using the old password for authentication. Passwords and usernames are unencrypted.

Parameters:

Flag Name Type Description
In Username Widestring
The username in clear text.
In OldPassword Widestring
The old password in clear text.
In NewPassword Widestring
The new password in clear text.

Return Value:

None.

Oxygene Syntax:

method LoginService.ChangePasswordWithOldPassword(const Username: Widestring ; const OldPassword: Widestring ; const NewPassword: Widestring);

C# Syntax:

public void LoginService.ChangePasswordWithOldPassword( String Username , String OldPassword , String NewPassword);

Delphi Syntax:

procedure LoginService.ChangePasswordWithOldPassword(const Username: Widestring ; const OldPassword: Widestring ; const NewPassword: Widestring) ;

Method ChangePasswordWithOldPassword2

Changes a user's password using the old password for authentication. Passwords and usernames are encrypted.

Parameters:

Flag Name Type Description
In EncryptedUsername WideString
The encrypted username.
In EncryptedOldPassword WideString
The encrypted old password.
In EncryptedNewPassword WideString
The encrypted new password.

Return Value:

None.

Oxygene Syntax:

method LoginService.ChangePasswordWithOldPassword2(const EncryptedUsername: WideString ; const EncryptedOldPassword: WideString ; const EncryptedNewPassword: WideString);

C# Syntax:

public void LoginService.ChangePasswordWithOldPassword2(WideString EncryptedUsername , WideString EncryptedOldPassword , WideString EncryptedNewPassword);

Delphi Syntax:

procedure LoginService.ChangePasswordWithOldPassword2(const EncryptedUsername: WideString ; const EncryptedOldPassword: WideString ; const EncryptedNewPassword: WideString) ;

Method ChangePasswordWithVerificationCode

Changes a user's password using a verification code for authentication. Passwords and usernames are unencrypted.

Parameters:

Flag Name Type Description
In Username Widestring
The username in clear text.
In VerificationCode Widestring
The verification code.
In NewPassword Widestring
The new password in clear text.

Return Value:

None.

Oxygene Syntax:

method LoginService.ChangePasswordWithVerificationCode(const Username: Widestring ; const VerificationCode: Widestring ; const NewPassword: Widestring);

C# Syntax:

public void LoginService.ChangePasswordWithVerificationCode( String Username , String VerificationCode , String NewPassword);

Delphi Syntax:

procedure LoginService.ChangePasswordWithVerificationCode(const Username: Widestring ; const VerificationCode: Widestring ; const NewPassword: Widestring) ;

Method ChangePasswordWithVerificationCode2

Changes a user's password using a verification code for authentication. Passwords and usernames are encrypted.

Parameters:

Flag Name Type Description
In EncryptedUsername WideString
The encrytped username.
In VerificationCode WideString
The verification code.
In EncryptedNewPassword WideString
The encrytped new password.

Return Value:

None.

Oxygene Syntax:

method LoginService.ChangePasswordWithVerificationCode2(const EncryptedUsername: WideString ; const VerificationCode: WideString ; const EncryptedNewPassword: WideString);

C# Syntax:

public void LoginService.ChangePasswordWithVerificationCode2(WideString EncryptedUsername , WideString VerificationCode , WideString EncryptedNewPassword);

Delphi Syntax:

procedure LoginService.ChangePasswordWithVerificationCode2(const EncryptedUsername: WideString ; const VerificationCode: WideString ; const EncryptedNewPassword: WideString) ;

Method DownloadClientInstallerChunk

Deprecated. Use DownloadInstallerChunk.

Downloads a chunk of the client installer for versions previous to 6.1.0.

Parameters:

Flag Name Type Description
In PartNo Int64
Species the chunk part number.
In PartSize Int64
Specifies the chunk part size.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method LoginService.DownloadClientInstallerChunk(const PartNo: Int64 ; const PartSize: Int64) : Binary;

C# Syntax:

public Binary LoginService.DownloadClientInstallerChunk(Int64 PartNo , Int64 PartSize);

Delphi Syntax:

function LoginService.DownloadClientInstallerChunk(const PartNo: Int64 ; const PartSize: Int64) : Binary;

Method DownloadIntallerChunk

Downloads a chunk of a client installer.

Parameters:

Flag Name Type Description
In ClientType TClientType
Specifies the type of client installer.
In PartNo Int64
Species the chunk part number.
In PartSize Int64
Specifies the chunk part size.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method LoginService.DownloadIntallerChunk(const ClientType: TClientType ; const PartNo: Int64 ; const PartSize: Int64) : Binary;

C# Syntax:

public Binary LoginService.DownloadIntallerChunk(TClientType ClientType , Int64 PartNo , Int64 PartSize);

Delphi Syntax:

function LoginService.DownloadIntallerChunk(const ClientType: TClientType ; const PartNo: Int64 ; const PartSize: Int64) : Binary;

Method GetDownloadClientSize

Deprecated. Use GetDownloadSize.

Returns the size of the client installer for versions previous to 6.1.0.

Parameters:

None.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method LoginService.GetDownloadClientSize() : Int64;

C# Syntax:

public Int64 LoginService.GetDownloadClientSize();

Delphi Syntax:

function LoginService.GetDownloadClientSize() : Int64;

Method GetDownloadSize

Returns the size of a client installer.

Parameters:

Flag Name Type Description
In ClientType TClientType
Specifies the type of client installer.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method LoginService.GetDownloadSize(const ClientType: TClientType) : Int64;

C# Syntax:

public Int64 LoginService.GetDownloadSize(TClientType ClientType);

Delphi Syntax:

function LoginService.GetDownloadSize(const ClientType: TClientType) : Int64;

Method LoggedIn

Returns true is the session is still logged in.

Parameters:

None.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method LoginService.LoggedIn() : Boolean;

C# Syntax:

public Boolean LoginService.LoggedIn();

Delphi Syntax:

function LoginService.LoggedIn() : Boolean;

Method Login

Logs on to the server and creates a new session.

Parameters:

Flag Name Type Description
In Username Widestring
The username in clear text.
In Password Widestring
The password in clear text.
In ClientVersion Integer
The client version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In InterfaceVersion Integer
The interface version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In ClientType TClientType
The type of client that is logging on.

Return Value:

Flag Name Type
Result Result TLoginInfo

Oxygene Syntax:

method LoginService.Login(const Username: Widestring ; const Password: Widestring ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ClientType: TClientType) : TLoginInfo;

C# Syntax:

public TLoginInfo LoginService.Login( String Username , String Password , Int32 ClientVersion , Int32 InterfaceVersion , TClientType ClientType);

Delphi Syntax:

function LoginService.Login(const Username: Widestring ; const Password: Widestring ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ClientType: TClientType) : TLoginInfo;

Method Login2

Logs on to the server using encrypted parameters and creates a new session.

Parameters:

Flag Name Type Description
In EncryptedUsername WideString
The encrypted username.
In EncryptedPassword WideString
The encrypted password.
In ClientVersion Integer
The client version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In InterfaceVersion Integer
The interface version. If this parameter is set to 0, no compatibility checks will be made on the server. It is then the responsibility of the client to make sure that it is compatible with the server.
In ClientType TClientType
The type of client that is logging on.

Return Value:

Flag Name Type
Result Result TLoginInfo

Oxygene Syntax:

method LoginService.Login2(const EncryptedUsername: WideString ; const EncryptedPassword: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ClientType: TClientType) : TLoginInfo;

C# Syntax:

public TLoginInfo LoginService.Login2(WideString EncryptedUsername , WideString EncryptedPassword , Int32 ClientVersion , Int32 InterfaceVersion , TClientType ClientType);

Delphi Syntax:

function LoginService.Login2(const EncryptedUsername: WideString ; const EncryptedPassword: WideString ; const ClientVersion: Integer ; const InterfaceVersion: Integer ; const ClientType: TClientType) : TLoginInfo;

Method Logout

Logs out of the current session.

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method LoginService.Logout();

C# Syntax:

public void LoginService.Logout();

Delphi Syntax:

procedure LoginService.Logout() ;

Method ForgottenPassword

Sends a a verification code to a user's registered email address. The verification code can be used to change the password.

Parameters:

Flag Name Type Description
In Username Widestring
The username in clear text.

Return Value:

None.

Oxygene Syntax:

method LoginService.ForgottenPassword(const Username: Widestring);

C# Syntax:

public void LoginService.ForgottenPassword( String Username);

Delphi Syntax:

procedure LoginService.ForgottenPassword(const Username: Widestring) ;

Method RequestUsername

Sends a username to the user's registered email address.

Parameters:

Flag Name Type Description
In EmailAddress Widestring
The email address in clear text.

Return Value:

None.

Oxygene Syntax:

method LoginService.RequestUsername(const EmailAddress: Widestring);

C# Syntax:

public void LoginService.RequestUsername( String EmailAddress);

Delphi Syntax:

procedure LoginService.RequestUsername(const EmailAddress: Widestring) ;
Service EasyIPAdmin

The following table lists the Operations defined in "EasyIPAdmin":

AddDiscoveryBot
Adds a new Discovery Bot.
AddFieldPendingChange
Adds a field update to the field update queue. The field updates will be implemented the next time the server is restarted.
AddUser
Adds a new user to Easy-IP. The return value is the ID of the new user.
AddUserGroup
Adds a user group to Easy-IP. Users that are added to a user group inherit the properties of the group. The return value is the ID of the new group.
BackupDatabase
Starts a backup of the database using the properties defined in the server settings.
CopyFilesToUsers
Copies virtual user files to selected user directories.
DatabaseScriptTestCompile
Attempts to compile the database script using the values in the Delta.
DatabaseScriptTestRun
Attempts to run the database script using the values in the Delta.
DeleteDatabaseBackup
Deletes the database specified in the parameter.
DeleteDatabaseFile
Deletes the database file specified in the parameter.
DeleteDiscoveryBot
Deletes a discovery bot.
DeleteEmailQueueItems
Delete items from the Email queue,
DeleteFieldPendingChange
Deletes a pending field change item.
DeleteQueuedDiscovery
Deletes a discovery item from the discovery queue.
DeleteUser
Deletes an Easy-IP user.
DeleteUserGroup
Delete a User Group.
DisconnectUserSessions
Forcibly disconnects Easy-IP user sesions. Before the session is discnnected, an event is sent to the client with an optional reason parameter.
EmailUsers
Sends an email to a list of users.
ForceUserPasswordChange
Sets the force user change flag of a user. Once set, the user will need to change their password before they can log in.
GetAuthenticationDetails
Returns a list of available authentication methods.
GetBackupFilelist
Returns a list of backup files from the backup directory.
GetClientSettings
Returns the client settings for the specified user.
GetDatabaseBackupLog
Returns the backup log for the backup file specified in BackupFilename.
GetDatabaseRestoreLog
Returns the log file of a database restore file.
GetEasyIPUser
Returns an Easy-IP user.
GetEasyIPUserGroups
Returns an array of all the Easy-IP user groups.
GetEasyIPUserGroupsAndUsers
Returns an array of Easy-IP user groups along with their associated users.
GetEasyIPUsers
Returns an array of all the Easy-IP users.
GetEmailQueueItems
Returns an array of items in the email queue.
GetFieldPendingUpdates
Returns an array of pending database updates.
GetRestoredDatabaseFilelist
Returns an array of restored database files.
GetServerRestartDateTime
Returns the date/time that the server is scheduled to restart. If the return value is 0, the server is not currently scheduled to restart.
GetServerSettings
Returns the server settings.
GetTableScript
Returns the table scripts associated with the Table Name.
GetUserDisabledFunctions
Returns an array of disabled functions.
GetUserPrivileges
Returns the user privileges for the specified user.
GetUserSessions
Returns an array with details of all the active user sessions.
GetValidFieldDataTypes
Returns an array containing types and descriptions of the database field types available in Easy-IP.
PurgeLogsAndBackups
Purges the log tables.
ReloadSettings
Forces the server to reload it's settings.
RenameUserGroup
Rename a user group.
RestartServer
Schedules a restart of the Easy-IP server.
RestoreDatabase
Restores a database to the default restore directory.
ScheduleDatabaseBackup
Creates a new backup event based on the backup parameters in the server settings.
SetClientSettings
Updates a client's settings.
SetDiscoveryBotEnabled
Enables/disables a discovery bot.
SetServerSettings
Updates the server settings.
SetTableScript
Updates a database table script.
SetUserDisabledFunctions
Sets the disabled user functions for the chosen users.
SetUserField
Sets the parameters for a user field.
SetUserFieldDisplayOrder
The new order for the user fields.
SetUserGroup
Sets the IDs of the users that belong to a specific user group.
SetUserPassword
Sets a user password.
SetUserPrivileges
Sets user privileges.
SetUserProperties
Sets user properties.
StartFullTextSearchIndexing
Starts rebuild of the full text search index.
UpdateDiscoveryBot
Updates a discovery bot's properties.
UpdateEmailQueueItems
Updates the status of email queue items.
UpdateMACAddressPrefixes
Requests the server to begin the process of downloading and updating the MAC address prefixes
UserExists
Returns TRUE if a user name exists.

Method AddDiscoveryBot

Adds a new Discovery Bot.

Parameters:

Flag Name Type Description
In Name WideString
The name of the Discovery Bot
In IPAddress WideString
The IP Address of the Discovery Bot
In SharedKey WideString
The shared key that the Discovery Bot has been configured with

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPAdmin.AddDiscoveryBot(const Name: WideString ; const IPAddress: WideString ; const SharedKey: WideString) : Int64;

C# Syntax:

public Int64 EasyIPAdmin.AddDiscoveryBot(WideString Name , WideString IPAddress , WideString SharedKey);

Delphi Syntax:

function EasyIPAdmin.AddDiscoveryBot(const Name: WideString ; const IPAddress: WideString ; const SharedKey: WideString) : Int64;

Method AddFieldPendingChange

Adds a field update to the field update queue. The field updates will be implemented the next time the server is restarted.

Parameters:

Flag Name Type Description
In FieldName Widestring
The name of the field to be updated
In TableName Widestring
The name of the table to to which the field belongs
In FieldUpdateAction TFieldUpdateAction
The type of action to be applied to the field
In FieldSize Integer
The new size for the field. The size must be the same as or greater than the current value
In FieldType TEIPDataType
The new data type for the field

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.AddFieldPendingChange(const FieldName: Widestring ; const TableName: Widestring ; const FieldUpdateAction: TFieldUpdateAction ; const FieldSize: Integer ; const FieldType: TEIPDataType);

C# Syntax:

public void EasyIPAdmin.AddFieldPendingChange( String FieldName , String TableName , TFieldUpdateAction FieldUpdateAction , Int32 FieldSize , TEIPDataType FieldType);

Delphi Syntax:

procedure EasyIPAdmin.AddFieldPendingChange(const FieldName: Widestring ; const TableName: Widestring ; const FieldUpdateAction: TFieldUpdateAction ; const FieldSize: Integer ; const FieldType: TEIPDataType) ;

Method AddUser

Adds a new user to Easy-IP. The return value is the ID of the new user.

Parameters:

Flag Name Type Description
In Username Widestring
The username for the new user.
In Name Widestring
The full name of the new user.
In UserType TUserType
The user type of the new user.
In AuthenticationType Widestring
The authentication type of the new user. Use 'native' for native Easy-IP users. Use 'winauth' for Windows (Active Directory) users.
In Email Widestring
The email addres of the new user (optional).
In ForcePasswordChangeNextLogin Boolean
If TRUE, the user will need to change their password the next time they login.
In GroupId Integer
The ID of the user group to which the user is added. The user will acquire all the privileges of the group they are added to. If this parameter is 0, the user will not be added to a group and their privileges can be changed independently.
In Password Widestring
The password for the new user. This parameter is only valid for Native Easy-IP Users.

If the password parameter is left empty and the Authentication Type is 'native', a new, random password will be generated and sent to the email address of the new user.
In EncryptedPassword Boolean
If this parameter is set to TRUE, the server will expect the password parameter to be encrypted. It should only be set to FALSE for all third party API clients.
In AccountDisabled Boolean
The user's Easy-IP account will be disabled if this parameter is set to TRUE.

Return Value:

Flag Name Type
Result Result Integer

Oxygene Syntax:

method EasyIPAdmin.AddUser(const Username: Widestring ; const Name: Widestring ; const UserType: TUserType ; const AuthenticationType: Widestring ; const Email: Widestring ; const ForcePasswordChangeNextLogin: Boolean ; const GroupId: Integer ; const Password: Widestring ; const EncryptedPassword: Boolean ; const AccountDisabled: Boolean) : Integer;

C# Syntax:

public Integer EasyIPAdmin.AddUser( String Username , String Name , TUserType UserType , String AuthenticationType , String Email , Boolean ForcePasswordChangeNextLogin , Int32 GroupId , String Password , Boolean EncryptedPassword , Boolean AccountDisabled);

Delphi Syntax:

function EasyIPAdmin.AddUser(const Username: Widestring ; const Name: Widestring ; const UserType: TUserType ; const AuthenticationType: Widestring ; const Email: Widestring ; const ForcePasswordChangeNextLogin: Boolean ; const GroupId: Integer ; const Password: Widestring ; const EncryptedPassword: Boolean ; const AccountDisabled: Boolean) : Integer;

Method AddUserGroup

Adds a user group to Easy-IP. Users that are added to a user group inherit the properties of the group. The return value is the ID of the new group.

Parameters:

Flag Name Type Description
In GroupName Widestring
The name of the new user group.

Return Value:

Flag Name Type
Result Result Integer

Oxygene Syntax:

method EasyIPAdmin.AddUserGroup(const GroupName: Widestring) : Integer;

C# Syntax:

public Integer EasyIPAdmin.AddUserGroup( String GroupName);

Delphi Syntax:

function EasyIPAdmin.AddUserGroup(const GroupName: Widestring) : Integer;

Method BackupDatabase

Starts a backup of the database using the properties defined in the server settings.

Parameters:

Flag Name Type Description
In MetadataOnly Boolean
If TRUE, only the database Metadata will be backed up.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.BackupDatabase(const MetadataOnly: Boolean);

C# Syntax:

public void EasyIPAdmin.BackupDatabase(Boolean MetadataOnly);

Delphi Syntax:

procedure EasyIPAdmin.BackupDatabase(const MetadataOnly: Boolean) ;

Method CopyFilesToUsers

Copies virtual user files to selected user directories.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SourceVirtualFileIDs TInt64Array
An array of the Virtual File IDs that you want to copy to the users.
In DestinationUserDirectory WideString
The directory path under the user directory to which you want the files to be copied.
In UserIDs TInt64Array
The IDs of the users whose virtual directories you want to copy the files to.
In OverwriteFiles Boolean
When TRUE, existing files wll be overwritten.
In CreateDirectories Boolean
When TRUE, new directories will be created.
In CopyAsShortcut Boolean
When TRUE, shortcuts will be created rather than actual file data. This is recommended as it saves space in the database.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPAdmin.CopyFilesToUsers(const OperationID: WideString ; const SourceVirtualFileIDs: TInt64Array ; const DestinationUserDirectory: WideString ; const UserIDs: TInt64Array ; const OverwriteFiles: Boolean ; const CreateDirectories: Boolean ; const CopyAsShortcut: Boolean) : WideString;

C# Syntax:

public WideString EasyIPAdmin.CopyFilesToUsers(WideString OperationID , TInt64Array SourceVirtualFileIDs , WideString DestinationUserDirectory , TInt64Array UserIDs , Boolean OverwriteFiles , Boolean CreateDirectories , Boolean CopyAsShortcut);

Delphi Syntax:

function EasyIPAdmin.CopyFilesToUsers(const OperationID: WideString ; const SourceVirtualFileIDs: TInt64Array ; const DestinationUserDirectory: WideString ; const UserIDs: TInt64Array ; const OverwriteFiles: Boolean ; const CreateDirectories: Boolean ; const CopyAsShortcut: Boolean) : WideString;

Method DatabaseScriptTestCompile

Attempts to compile the database script using the values in the Delta.

Parameters:

Flag Name Type Description
InOut DeltaChangeValues TEasyIPDeltaChangeValues
The field values that will be passed to the script.
In Script Widestring
The script that will be tested. Currently, the script supports Pascal syntax.
Out ErrorMessage Widestring
The error message (if any) that was generated by the script.
Out ErrorX Integer
The X position of the error in the script.
Out ErrorY Integer
The Y position of the error in the script.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPAdmin.DatabaseScriptTestCompile(var DeltaChangeValues: TEasyIPDeltaChangeValues ; const Script: Widestring ; ErrorMessage: Widestring ; ErrorX: Integer ; ErrorY: Integer) : Boolean;

C# Syntax:

public Boolean EasyIPAdmin.DatabaseScriptTestCompile(ref TEasyIPDeltaChangeValues DeltaChangeValues , String Script , out String ErrorMessage , out Int32 ErrorX , out Int32 ErrorY);

Delphi Syntax:

function EasyIPAdmin.DatabaseScriptTestCompile(var DeltaChangeValues: TEasyIPDeltaChangeValues ; const Script: Widestring ; ErrorMessage: Widestring ; ErrorX: Integer ; ErrorY: Integer) : Boolean;

Method DatabaseScriptTestRun

Attempts to run the database script using the values in the Delta.

Parameters:

Flag Name Type Description
InOut DeltaChangeValues TEasyIPDeltaChangeValues
The field values that will be passed to the script.
In Script Widestring
The script that will be tested. Currently, the script supports Pascal syntax.
Out ErrorMessage Widestring
The error message (if any) that was generated by the script.
Out ErrorX Integer
The X position of the error in the script.
Out ErrorY Integer
The Y position of the error in the script.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPAdmin.DatabaseScriptTestRun(var DeltaChangeValues: TEasyIPDeltaChangeValues ; const Script: Widestring ; ErrorMessage: Widestring ; ErrorX: Integer ; ErrorY: Integer) : Boolean;

C# Syntax:

public Boolean EasyIPAdmin.DatabaseScriptTestRun(ref TEasyIPDeltaChangeValues DeltaChangeValues , String Script , out String ErrorMessage , out Int32 ErrorX , out Int32 ErrorY);

Delphi Syntax:

function EasyIPAdmin.DatabaseScriptTestRun(var DeltaChangeValues: TEasyIPDeltaChangeValues ; const Script: Widestring ; ErrorMessage: Widestring ; ErrorX: Integer ; ErrorY: Integer) : Boolean;

Method DeleteDatabaseBackup

Deletes the database specified in the parameter.

Parameters:

Flag Name Type Description
In BackupFilename WideString
The filename of the backup file that you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteDatabaseBackup(const BackupFilename: WideString);

C# Syntax:

public void EasyIPAdmin.DeleteDatabaseBackup(WideString BackupFilename);

Delphi Syntax:

procedure EasyIPAdmin.DeleteDatabaseBackup(const BackupFilename: WideString) ;

Method DeleteDatabaseFile

Deletes the database file specified in the parameter.

Parameters:

Flag Name Type Description
In DatabaseFilename WideString
The filename of the database you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteDatabaseFile(const DatabaseFilename: WideString);

C# Syntax:

public void EasyIPAdmin.DeleteDatabaseFile(WideString DatabaseFilename);

Delphi Syntax:

procedure EasyIPAdmin.DeleteDatabaseFile(const DatabaseFilename: WideString) ;

Method DeleteDiscoveryBot

Deletes a discovery bot.

Parameters:

Flag Name Type Description
In DiscoveryBotId Int64
The ID of the Discovery Bot that you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteDiscoveryBot(const DiscoveryBotId: Int64);

C# Syntax:

public void EasyIPAdmin.DeleteDiscoveryBot(Int64 DiscoveryBotId);

Delphi Syntax:

procedure EasyIPAdmin.DeleteDiscoveryBot(const DiscoveryBotId: Int64) ;

Method DeleteEmailQueueItems

Delete items from the Email queue,

Parameters:

Flag Name Type Description
In EmailQueueItemIds TInt64Array
An array of Email queue item IDs that will deleted from the Email queue.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteEmailQueueItems(const EmailQueueItemIds: TInt64Array);

C# Syntax:

public void EasyIPAdmin.DeleteEmailQueueItems(TInt64Array EmailQueueItemIds);

Delphi Syntax:

procedure EasyIPAdmin.DeleteEmailQueueItems(const EmailQueueItemIds: TInt64Array) ;

Method DeleteFieldPendingChange

Deletes a pending field change item.

Parameters:

Flag Name Type Description
In FieldName Widestring
The field name of the pending change item you want to delete.
In TableId Integer
The table ID of the pending change item you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteFieldPendingChange(const FieldName: Widestring ; const TableId: Integer);

C# Syntax:

public void EasyIPAdmin.DeleteFieldPendingChange( String FieldName , Int32 TableId);

Delphi Syntax:

procedure EasyIPAdmin.DeleteFieldPendingChange(const FieldName: Widestring ; const TableId: Integer) ;

Method DeleteQueuedDiscovery

Deletes a discovery item from the discovery queue.

Parameters:

Flag Name Type Description
In DiscoveryId Int64
The ID of the discovery item you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteQueuedDiscovery(const DiscoveryId: Int64);

C# Syntax:

public void EasyIPAdmin.DeleteQueuedDiscovery(Int64 DiscoveryId);

Delphi Syntax:

procedure EasyIPAdmin.DeleteQueuedDiscovery(const DiscoveryId: Int64) ;

Method DeleteUser

Deletes an Easy-IP user.

Parameters:

Flag Name Type Description
In UserId Integer
The ID of the user you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteUser(const UserId: Integer);

C# Syntax:

public void EasyIPAdmin.DeleteUser( Int32 UserId);

Delphi Syntax:

procedure EasyIPAdmin.DeleteUser(const UserId: Integer) ;

Method DeleteUserGroup

Delete a User Group.

Parameters:

Flag Name Type Description
In GroupId Integer
The ID of the user group you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DeleteUserGroup(const GroupId: Integer);

C# Syntax:

public void EasyIPAdmin.DeleteUserGroup( Int32 GroupId);

Delphi Syntax:

procedure EasyIPAdmin.DeleteUserGroup(const GroupId: Integer) ;

Method DisconnectUserSessions

Forcibly disconnects Easy-IP user sesions. Before the session is discnnected, an event is sent to the client with an optional reason parameter.

Parameters:

Flag Name Type Description
In SessionIds TStringArray
An array of the session IDs of the sessions you want to disconnect.
In Reason WideString
The reason will be pushed to the user in the disconnect event. The reason can be displayed by the client if required.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.DisconnectUserSessions(const SessionIds: TStringArray ; const Reason: WideString);

C# Syntax:

public void EasyIPAdmin.DisconnectUserSessions(TStringArray SessionIds , WideString Reason);

Delphi Syntax:

procedure EasyIPAdmin.DisconnectUserSessions(const SessionIds: TStringArray ; const Reason: WideString) ;

Method EmailUsers

Sends an email to a list of users.

Parameters:

Flag Name Type Description
In UserIds TInt64Array
An array of IDs of the users that you want to send the email to.
In Subject WideString
The subject of the email.
In MessageBody WideString
The text body of the email.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.EmailUsers(const UserIds: TInt64Array ; const Subject: WideString ; const MessageBody: WideString);

C# Syntax:

public void EasyIPAdmin.EmailUsers(TInt64Array UserIds , WideString Subject , WideString MessageBody);

Delphi Syntax:

procedure EasyIPAdmin.EmailUsers(const UserIds: TInt64Array ; const Subject: WideString ; const MessageBody: WideString) ;

Method ForceUserPasswordChange

Sets the force user change flag of a user. Once set, the user will need to change their password before they can log in.

Parameters:

Flag Name Type Description
In UserId Int64
The ID of the User account.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.ForceUserPasswordChange(const UserId: Int64);

C# Syntax:

public void EasyIPAdmin.ForceUserPasswordChange(Int64 UserId);

Delphi Syntax:

procedure EasyIPAdmin.ForceUserPasswordChange(const UserId: Int64) ;

Method GetAuthenticationDetails

Returns a list of available authentication methods.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TAuthenticationDetails

Oxygene Syntax:

method EasyIPAdmin.GetAuthenticationDetails() : TAuthenticationDetails;

C# Syntax:

public TAuthenticationDetails EasyIPAdmin.GetAuthenticationDetails();

Delphi Syntax:

function EasyIPAdmin.GetAuthenticationDetails() : TAuthenticationDetails;

Method GetBackupFilelist

Returns a list of backup files from the backup directory.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TFileInfoArray

Oxygene Syntax:

method EasyIPAdmin.GetBackupFilelist() : TFileInfoArray;

C# Syntax:

public TFileInfoArray EasyIPAdmin.GetBackupFilelist();

Delphi Syntax:

function EasyIPAdmin.GetBackupFilelist() : TFileInfoArray;

Method GetClientSettings

Returns the client settings for the specified user.

Parameters:

Flag Name Type Description
In Username Widestring
The client settings will be returned for the account specified in this parameter.

Return Value:

Flag Name Type
Result Result TClientSettings

Oxygene Syntax:

method EasyIPAdmin.GetClientSettings(const Username: Widestring) : TClientSettings;

C# Syntax:

public TClientSettings EasyIPAdmin.GetClientSettings( String Username);

Delphi Syntax:

function EasyIPAdmin.GetClientSettings(const Username: Widestring) : TClientSettings;

Method GetDatabaseBackupLog

Returns the backup log for the backup file specified in BackupFilename.

Parameters:

Flag Name Type Description
In BackupFilename WideString
The filename of the backup file whose log file you want to retrieve.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPAdmin.GetDatabaseBackupLog(const BackupFilename: WideString) : WideString;

C# Syntax:

public WideString EasyIPAdmin.GetDatabaseBackupLog(WideString BackupFilename);

Delphi Syntax:

function EasyIPAdmin.GetDatabaseBackupLog(const BackupFilename: WideString) : WideString;

Method GetDatabaseRestoreLog

Returns the log file of a database restore file.

Parameters:

Flag Name Type Description
In DatabaseFilename WideString
The filename of the restore file whose log file you want to retrieve.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPAdmin.GetDatabaseRestoreLog(const DatabaseFilename: WideString) : WideString;

C# Syntax:

public WideString EasyIPAdmin.GetDatabaseRestoreLog(WideString DatabaseFilename);

Delphi Syntax:

function EasyIPAdmin.GetDatabaseRestoreLog(const DatabaseFilename: WideString) : WideString;

Method GetEasyIPUser

Returns an Easy-IP user.

Parameters:

Flag Name Type Description
In UserID Integer
The ID of the user you want to retrieve.

Return Value:

Flag Name Type
Result Result TEasyIPUser

Oxygene Syntax:

method EasyIPAdmin.GetEasyIPUser(const UserID: Integer) : TEasyIPUser;

C# Syntax:

public TEasyIPUser EasyIPAdmin.GetEasyIPUser( Int32 UserID);

Delphi Syntax:

function EasyIPAdmin.GetEasyIPUser(const UserID: Integer) : TEasyIPUser;

Method GetEasyIPUserGroups

Returns an array of all the Easy-IP user groups.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TEasyIPUserGroups

Oxygene Syntax:

method EasyIPAdmin.GetEasyIPUserGroups() : TEasyIPUserGroups;

C# Syntax:

public TEasyIPUserGroups EasyIPAdmin.GetEasyIPUserGroups();

Delphi Syntax:

function EasyIPAdmin.GetEasyIPUserGroups() : TEasyIPUserGroups;

Method GetEasyIPUserGroupsAndUsers

Returns an array of Easy-IP user groups along with their associated users.

Parameters:

Flag Name Type Description
In IncludeDeletedUsers Boolean
When TRUE, deleted users will be included in the user lists.

Return Value:

Flag Name Type
Result Result TEasyIPUserGroups

Oxygene Syntax:

method EasyIPAdmin.GetEasyIPUserGroupsAndUsers(const IncludeDeletedUsers: Boolean) : TEasyIPUserGroups;

C# Syntax:

public TEasyIPUserGroups EasyIPAdmin.GetEasyIPUserGroupsAndUsers(Boolean IncludeDeletedUsers);

Delphi Syntax:

function EasyIPAdmin.GetEasyIPUserGroupsAndUsers(const IncludeDeletedUsers: Boolean) : TEasyIPUserGroups;

Method GetEasyIPUsers

Returns an array of all the Easy-IP users.

Parameters:

Flag Name Type Description
In IncludeDeletedUsers Boolean
When TRUE, deleted users will be included in the list.

Return Value:

Flag Name Type
Result Result TEasyIPUsers

Oxygene Syntax:

method EasyIPAdmin.GetEasyIPUsers(const IncludeDeletedUsers: Boolean) : TEasyIPUsers;

C# Syntax:

public TEasyIPUsers EasyIPAdmin.GetEasyIPUsers(Boolean IncludeDeletedUsers);

Delphi Syntax:

function EasyIPAdmin.GetEasyIPUsers(const IncludeDeletedUsers: Boolean) : TEasyIPUsers;

Method GetEmailQueueItems

Returns an array of items in the email queue.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TEmailQueueItems

Oxygene Syntax:

method EasyIPAdmin.GetEmailQueueItems() : TEmailQueueItems;

C# Syntax:

public TEmailQueueItems EasyIPAdmin.GetEmailQueueItems();

Delphi Syntax:

function EasyIPAdmin.GetEmailQueueItems() : TEmailQueueItems;

Method GetFieldPendingUpdates

Returns an array of pending database updates.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TFieldPendingUpdates

Oxygene Syntax:

method EasyIPAdmin.GetFieldPendingUpdates() : TFieldPendingUpdates;

C# Syntax:

public TFieldPendingUpdates EasyIPAdmin.GetFieldPendingUpdates();

Delphi Syntax:

function EasyIPAdmin.GetFieldPendingUpdates() : TFieldPendingUpdates;

Method GetRestoredDatabaseFilelist

Returns an array of restored database files.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TFileInfoArray

Oxygene Syntax:

method EasyIPAdmin.GetRestoredDatabaseFilelist() : TFileInfoArray;

C# Syntax:

public TFileInfoArray EasyIPAdmin.GetRestoredDatabaseFilelist();

Delphi Syntax:

function EasyIPAdmin.GetRestoredDatabaseFilelist() : TFileInfoArray;

Method GetServerRestartDateTime

Returns the date/time that the server is scheduled to restart. If the return value is 0, the server is not currently scheduled to restart.

Parameters:

None.

Return Value:

Flag Name Type
Result Result DateTime

Oxygene Syntax:

method EasyIPAdmin.GetServerRestartDateTime() : DateTime;

C# Syntax:

public DateTime EasyIPAdmin.GetServerRestartDateTime();

Delphi Syntax:

function EasyIPAdmin.GetServerRestartDateTime() : DateTime;

Method GetServerSettings

Returns the server settings.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TServerSettings

Oxygene Syntax:

method EasyIPAdmin.GetServerSettings() : TServerSettings;

C# Syntax:

public TServerSettings EasyIPAdmin.GetServerSettings();

Delphi Syntax:

function EasyIPAdmin.GetServerSettings() : TServerSettings;

Method GetTableScript

Returns the table scripts associated with the Table Name.

Parameters:

Flag Name Type Description
In TableName Widestring
Specifies the name of the table whose scripts you want to return.

Return Value:

Flag Name Type
Result Result TTableScript

Oxygene Syntax:

method EasyIPAdmin.GetTableScript(const TableName: Widestring) : TTableScript;

C# Syntax:

public TTableScript EasyIPAdmin.GetTableScript( String TableName);

Delphi Syntax:

function EasyIPAdmin.GetTableScript(const TableName: Widestring) : TTableScript;

Method GetUserDisabledFunctions

Returns an array of disabled functions.

Parameters:

Flag Name Type Description
In UserId Int64
The user ID of the user functions that you want to retrieve.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPAdmin.GetUserDisabledFunctions(const UserId: Int64) : TStringArray;

C# Syntax:

public TStringArray EasyIPAdmin.GetUserDisabledFunctions(Int64 UserId);

Delphi Syntax:

function EasyIPAdmin.GetUserDisabledFunctions(const UserId: Int64) : TStringArray;

Method GetUserPrivileges

Returns the user privileges for the specified user.

Parameters:

Flag Name Type Description
In UserId Int64
The user ID whose privileges you want to retrieve.

Return Value:

Flag Name Type
Result Result TUserPrivileges

Oxygene Syntax:

method EasyIPAdmin.GetUserPrivileges(const UserId: Int64) : TUserPrivileges;

C# Syntax:

public TUserPrivileges EasyIPAdmin.GetUserPrivileges(Int64 UserId);

Delphi Syntax:

function EasyIPAdmin.GetUserPrivileges(const UserId: Int64) : TUserPrivileges;

Method GetUserSessions

Returns an array with details of all the active user sessions.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TUserSessions

Oxygene Syntax:

method EasyIPAdmin.GetUserSessions() : TUserSessions;

C# Syntax:

public TUserSessions EasyIPAdmin.GetUserSessions();

Delphi Syntax:

function EasyIPAdmin.GetUserSessions() : TUserSessions;

Method GetValidFieldDataTypes

Returns an array containing types and descriptions of the database field types available in Easy-IP.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TFieldDataTypeInfos

Oxygene Syntax:

method EasyIPAdmin.GetValidFieldDataTypes() : TFieldDataTypeInfos;

C# Syntax:

public TFieldDataTypeInfos EasyIPAdmin.GetValidFieldDataTypes();

Delphi Syntax:

function EasyIPAdmin.GetValidFieldDataTypes() : TFieldDataTypeInfos;

Method PurgeLogsAndBackups

Purges the log tables.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In PurgeBackupsDays Integer
The number of days of backups to keep. If this parameter is zero, the backups will not be purged.
In PurgeChangeLogDays Integer
The number of days of purge logs to keep. If this parameter is zero, the purge logs will not be purged.
In PurgePingLogDays Integer
The number of days of ping logs to keep. If this parameter is zero, the ping logs will not be purged.
Out Errors WideString
If any errors occur, they are returned in this parameter.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPAdmin.PurgeLogsAndBackups(const OperationId: WideString ; const PurgeBackupsDays: Integer ; const PurgeChangeLogDays: Integer ; const PurgePingLogDays: Integer ; Errors: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPAdmin.PurgeLogsAndBackups(WideString OperationId , Int32 PurgeBackupsDays , Int32 PurgeChangeLogDays , Int32 PurgePingLogDays , out WideString Errors);

Delphi Syntax:

function EasyIPAdmin.PurgeLogsAndBackups(const OperationId: WideString ; const PurgeBackupsDays: Integer ; const PurgeChangeLogDays: Integer ; const PurgePingLogDays: Integer ; Errors: WideString) : Boolean;

Method ReloadSettings

Forces the server to reload it's settings.

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.ReloadSettings();

C# Syntax:

public void EasyIPAdmin.ReloadSettings();

Delphi Syntax:

procedure EasyIPAdmin.ReloadSettings() ;

Method RenameUserGroup

Rename a user group.

Parameters:

Flag Name Type Description
In GroupId Integer
The ID of the user group you want to rename.
In GroupName Widestring
The new name for the group.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.RenameUserGroup(const GroupId: Integer ; const GroupName: Widestring);

C# Syntax:

public void EasyIPAdmin.RenameUserGroup( Int32 GroupId , String GroupName);

Delphi Syntax:

procedure EasyIPAdmin.RenameUserGroup(const GroupId: Integer ; const GroupName: Widestring) ;

Method RestartServer

Schedules a restart of the Easy-IP server.

Parameters:

Flag Name Type Description
In RestartDateTime DateTime
The date/time you want the server to restart.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.RestartServer(const RestartDateTime: DateTime);

C# Syntax:

public void EasyIPAdmin.RestartServer(DateTime RestartDateTime);

Delphi Syntax:

procedure EasyIPAdmin.RestartServer(const RestartDateTime: DateTime) ;

Method RestoreDatabase

Restores a database to the default restore directory.

Parameters:

Flag Name Type Description
In BackupFilename WideString
The name of the backup file you want to create.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.RestoreDatabase(const BackupFilename: WideString);

C# Syntax:

public void EasyIPAdmin.RestoreDatabase(WideString BackupFilename);

Delphi Syntax:

procedure EasyIPAdmin.RestoreDatabase(const BackupFilename: WideString) ;

Method ScheduleDatabaseBackup

Creates a new backup event based on the backup parameters in the server settings.

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.ScheduleDatabaseBackup();

C# Syntax:

public void EasyIPAdmin.ScheduleDatabaseBackup();

Delphi Syntax:

procedure EasyIPAdmin.ScheduleDatabaseBackup() ;

Method SetClientSettings

Updates a client's settings.

Parameters:

Flag Name Type Description
In Username Widestring
The username of the client (account) whose settings you want to update.
In ClientSettings TClientSettings
The new client settings.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetClientSettings(const Username: Widestring ; const ClientSettings: TClientSettings);

C# Syntax:

public void EasyIPAdmin.SetClientSettings( String Username , TClientSettings ClientSettings);

Delphi Syntax:

procedure EasyIPAdmin.SetClientSettings(const Username: Widestring ; const ClientSettings: TClientSettings) ;

Method SetDiscoveryBotEnabled

Enables/disables a discovery bot.

Parameters:

Flag Name Type Description
In DiscoveryBotId Int64
The ID of the Discovery Bot.
In Enabled Boolean
Whether or not the Discovery Bot should be enabled.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetDiscoveryBotEnabled(const DiscoveryBotId: Int64 ; const Enabled: Boolean);

C# Syntax:

public void EasyIPAdmin.SetDiscoveryBotEnabled(Int64 DiscoveryBotId , Boolean Enabled);

Delphi Syntax:

procedure EasyIPAdmin.SetDiscoveryBotEnabled(const DiscoveryBotId: Int64 ; const Enabled: Boolean) ;

Method SetServerSettings

Updates the server settings.

Parameters:

Flag Name Type Description
In ServerSettings TServerSettings
The new server settings.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetServerSettings(const ServerSettings: TServerSettings);

C# Syntax:

public void EasyIPAdmin.SetServerSettings(TServerSettings ServerSettings);

Delphi Syntax:

procedure EasyIPAdmin.SetServerSettings(const ServerSettings: TServerSettings) ;

Method SetTableScript

Updates a database table script.

Parameters:

Flag Name Type Description
In TableScript TTableScript
The new database script.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetTableScript(const TableScript: TTableScript);

C# Syntax:

public void EasyIPAdmin.SetTableScript(TTableScript TableScript);

Delphi Syntax:

procedure EasyIPAdmin.SetTableScript(const TableScript: TTableScript) ;

Method SetUserDisabledFunctions

Sets the disabled user functions for the chosen users.

Parameters:

Flag Name Type Description
In UserIds TInt64Array
The IDs of the users whose disabled functions you want to update.
In DisabledUserFunctions TStringArray
An array of the disabled user function strings.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserDisabledFunctions(const UserIds: TInt64Array ; const DisabledUserFunctions: TStringArray);

C# Syntax:

public void EasyIPAdmin.SetUserDisabledFunctions(TInt64Array UserIds , TStringArray DisabledUserFunctions);

Delphi Syntax:

procedure EasyIPAdmin.SetUserDisabledFunctions(const UserIds: TInt64Array ; const DisabledUserFunctions: TStringArray) ;

Method SetUserField

Sets the parameters for a user field.

Parameters:

Flag Name Type Description
In UserField TUserField
The user field properties.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserField(const UserField: TUserField);

C# Syntax:

public void EasyIPAdmin.SetUserField(TUserField UserField);

Delphi Syntax:

procedure EasyIPAdmin.SetUserField(const UserField: TUserField) ;

Method SetUserFieldDisplayOrder

The new order for the user fields.

Parameters:

Flag Name Type Description
In UserFieldDisplayOrders TUserFieldDisplayOrders

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserFieldDisplayOrder(const UserFieldDisplayOrders: TUserFieldDisplayOrders);

C# Syntax:

public void EasyIPAdmin.SetUserFieldDisplayOrder(TUserFieldDisplayOrders UserFieldDisplayOrders);

Delphi Syntax:

procedure EasyIPAdmin.SetUserFieldDisplayOrder(const UserFieldDisplayOrders: TUserFieldDisplayOrders) ;

Method SetUserGroup

Sets the IDs of the users that belong to a specific user group.

Parameters:

Flag Name Type Description
In UserIds TInt64Array
An array of user IDs that will be moved to the user group.
In GroupId Int64
The ID of the group that the users will be moved to.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserGroup(const UserIds: TInt64Array ; const GroupId: Int64);

C# Syntax:

public void EasyIPAdmin.SetUserGroup(TInt64Array UserIds , Int64 GroupId);

Delphi Syntax:

procedure EasyIPAdmin.SetUserGroup(const UserIds: TInt64Array ; const GroupId: Int64) ;

Method SetUserPassword

Sets a user password.

Parameters:

Flag Name Type Description
In UserId Integer
The user ID.
In Password Widestring
The new password.
In EncryptedPassword Boolean
If this parameter is TRUE, the server will expect it to be encrypted.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserPassword(const UserId: Integer ; const Password: Widestring ; const EncryptedPassword: Boolean);

C# Syntax:

public void EasyIPAdmin.SetUserPassword( Int32 UserId , String Password , Boolean EncryptedPassword);

Delphi Syntax:

procedure EasyIPAdmin.SetUserPassword(const UserId: Integer ; const Password: Widestring ; const EncryptedPassword: Boolean) ;

Method SetUserPrivileges

Sets user privileges.

Parameters:

Flag Name Type Description
In UserIds TInt64Array
An array of user IDs whose privileges will be updated.
In UserPrivileges TUserPrivileges
The user privileges that will be applied to the users.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserPrivileges(const UserIds: TInt64Array ; const UserPrivileges: TUserPrivileges);

C# Syntax:

public void EasyIPAdmin.SetUserPrivileges(TInt64Array UserIds , TUserPrivileges UserPrivileges);

Delphi Syntax:

procedure EasyIPAdmin.SetUserPrivileges(const UserIds: TInt64Array ; const UserPrivileges: TUserPrivileges) ;

Method SetUserProperties

Sets user properties.

Parameters:

Flag Name Type Description
In UserId Integer
The user ID of the account you want to update.
In Name Widestring
The new full name.
In UserType TUserType
The new user type.
In AuthenticationType Widestring
The new authentication type.
In Email Widestring
The new email address.
In ForcePasswordChangeNextLogin Boolean
Whether or not the user needs to change their password before logging in.
In AccountDisabled Boolean
Whether or not the user account is disabled.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.SetUserProperties(const UserId: Integer ; const Name: Widestring ; const UserType: TUserType ; const AuthenticationType: Widestring ; const Email: Widestring ; const ForcePasswordChangeNextLogin: Boolean ; const AccountDisabled: Boolean);

C# Syntax:

public void EasyIPAdmin.SetUserProperties( Int32 UserId , String Name , TUserType UserType , String AuthenticationType , String Email , Boolean ForcePasswordChangeNextLogin , Boolean AccountDisabled);

Delphi Syntax:

procedure EasyIPAdmin.SetUserProperties(const UserId: Integer ; const Name: Widestring ; const UserType: TUserType ; const AuthenticationType: Widestring ; const Email: Widestring ; const ForcePasswordChangeNextLogin: Boolean ; const AccountDisabled: Boolean) ;

Method StartFullTextSearchIndexing

Starts rebuild of the full text search index.

Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.StartFullTextSearchIndexing();

C# Syntax:

public void EasyIPAdmin.StartFullTextSearchIndexing();

Delphi Syntax:

procedure EasyIPAdmin.StartFullTextSearchIndexing() ;

Method UpdateDiscoveryBot

Updates a discovery bot's properties.

Parameters:

Flag Name Type Description
In DiscoveryBotId Int64
The ID of the discovery bot.
In Name WideString
The new name for the discovery bot.
In IPAddress WideString
The new IP Address for the Discovery Bot.
In SharedKey WideString
The new shared key for the Discovery Bot.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.UpdateDiscoveryBot(const DiscoveryBotId: Int64 ; const Name: WideString ; const IPAddress: WideString ; const SharedKey: WideString);

C# Syntax:

public void EasyIPAdmin.UpdateDiscoveryBot(Int64 DiscoveryBotId , WideString Name , WideString IPAddress , WideString SharedKey);

Delphi Syntax:

procedure EasyIPAdmin.UpdateDiscoveryBot(const DiscoveryBotId: Int64 ; const Name: WideString ; const IPAddress: WideString ; const SharedKey: WideString) ;

Method UpdateEmailQueueItems

Updates the status of email queue items.

Parameters:

Flag Name Type Description
In EmailQueueItemIds TInt64Array
An array of the email queue item IDs you want to update.
In Status TEmailQueueItemStatus
The new status for the email queue items.

Return Value:

None.

Oxygene Syntax:

method EasyIPAdmin.UpdateEmailQueueItems(const EmailQueueItemIds: TInt64Array ; const Status: TEmailQueueItemStatus);

C# Syntax:

public void EasyIPAdmin.UpdateEmailQueueItems(TInt64Array EmailQueueItemIds , TEmailQueueItemStatus Status);

Delphi Syntax:

procedure EasyIPAdmin.UpdateEmailQueueItems(const EmailQueueItemIds: TInt64Array ; const Status: TEmailQueueItemStatus) ;

Method UpdateMACAddressPrefixes

Requests the server to begin the process of downloading and updating the MAC address prefixes

Parameters:

None.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPAdmin.UpdateMACAddressPrefixes() : Boolean;

C# Syntax:

public Boolean EasyIPAdmin.UpdateMACAddressPrefixes();

Delphi Syntax:

function EasyIPAdmin.UpdateMACAddressPrefixes() : Boolean;

Method UserExists

Returns TRUE if a user name exists.

Parameters:

Flag Name Type Description
In Username WideString
The username you want to check.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPAdmin.UserExists(const Username: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPAdmin.UserExists(WideString Username);

Delphi Syntax:

function EasyIPAdmin.UserExists(const Username: WideString) : Boolean;
Service EasyIPEdit

The following table lists the Operations defined in "EasyIPEdit":

AddAddressesToSubnet
Adds a list of IP addresses to a subnet.
AddAddressRangeToSubnet
Adds a range of IP Addresses to a subnet.
AddAllAddressesToSubnets
Adds all valid IP Addresses to a list of subnets.
AddAllChildSubnets
Adds all the child subnets to a subnet using the cidr mask provided.
AddAutonomousNetwork
Adds a new autonomous network. The user that creates the autonomous network will be given full privileges to the new autonomous network. Other users will need to be granted the privileges specifically.
AddChildSubnets
Adds specific child subnets to a subnet.
AddGroup
Adds a new group to an autonomous network or group.
AddGroups
Adds multiple groups to an autonomous network or group.
AddIPAddressLinkDescription
Adds an IP Address link description and returns the new ID.
AddIPAddressLinks
Adds IP address links.

If the first and second ID arrays contain the same number of items, one to one links will be created.
If the first or second array contains a single item and the other array contains multiple items, a one to many relationship will be created.

The link description must already have been created using the AddIPAddressLinkDescription method.
AddSubnets
Adds a list of root Subets to a group or autonomous network.
AddSubnetsToCorrectParents
Adds a list of subnets to their correct parent subnets. If the subnet does not have a parent, it will be added to the default parent.
ApplyDelta
Applies changes to the user data in the Subnet or Address table.
DeleteAddressesFromSubnets
Delete all the IP Addresses from a list of subnets.
DeleteAutonomousNetwork
Deletes an autonomous network. The autonomous network must be empty before you can delete it.
DeleteGroupsOrSubnets
Delete groups/subnets.
DeleteIPAddressesById
Deletes a list of IP addresses.
DeleteIPAddressLinks
Deletes IP address links.
DeleteSubnetChildren
Deletes the children of subnets. Any IP addresses that belong to the deleted child subnets will be moved to the parent.
ImportFromXML
Imports data in an XML format.
MoveGroupsAndSubnets
Move groups/subnets from one parent to another.
PasteGroupStructure
Pastes the structure of an existing group hierarchy to a new location.
PasteSubnetStructure
Pastes the structure of an existing subnet hierarchy to a new location. The destination subnets must have the sampe IP Address type and CIDR mask as the source subnet.
RemoveParentSubnets
Removes the parent subnets from the subnet subnets that are defined in SubnetIds
ReparentChildSubnets
Adds a new parent subnet between the parent subnet and a number of it's child subnets.
Undo
Undoes the last edit operation.
UpdateAutonomousNetwork
Updates the name and notes associated with an autonomous network.
UpdateGroup
Update a group.
UpdateUserFields
Updates the values of specific user data fields.
CreateNextAvailableIPAddress
Creates the next available IP address in a subnet and returns its ID. If UpdateFieldName has a value it will be updated with the value in UpdateFieldValue.
ReserveNextAvailableIPAddress
Sets the value of a field in the first matching IP address record. The IP Address ID is returned.

Method AddAddressesToSubnet

Adds a list of IP addresses to a subnet.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The ID of the subnet that you want to add IP addresses to.
In IPAddresses TStringArray
The list of IP Addresses that you want to add. The addresses must fall into the range of the subnet specified by the subnet ID.
In ReturnAddedAddresses Boolean
If true, a list of IP addresses that are added are returned in the result.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddAddressesToSubnet(const OperationId: Widestring ; const SubnetId: Int64 ; const IPAddresses: TStringArray ; const ReturnAddedAddresses: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddAddressesToSubnet( String OperationId , Int64 SubnetId , TStringArray IPAddresses , Boolean ReturnAddedAddresses);

Delphi Syntax:

function EasyIPEdit.AddAddressesToSubnet(const OperationId: Widestring ; const SubnetId: Int64 ; const IPAddresses: TStringArray ; const ReturnAddedAddresses: Boolean) : TEditResult;

Method AddAddressRangeToSubnet

Adds a range of IP Addresses to a subnet.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The ID of the subnet that you want to add IP addresses to.
In LowIPAddress Widestring
The low IP Address of the range.
In HighIPAddress Widestring
The high IP Address of the range.
In ReturnAddedAddresses Boolean
If true, a list of IP addresses that are added are returned in the result.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddAddressRangeToSubnet(const OperationId: Widestring ; const SubnetId: Int64 ; const LowIPAddress: Widestring ; const HighIPAddress: Widestring ; const ReturnAddedAddresses: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddAddressRangeToSubnet( String OperationId , Int64 SubnetId , String LowIPAddress , String HighIPAddress , Boolean ReturnAddedAddresses);

Delphi Syntax:

function EasyIPEdit.AddAddressRangeToSubnet(const OperationId: Widestring ; const SubnetId: Int64 ; const LowIPAddress: Widestring ; const HighIPAddress: Widestring ; const ReturnAddedAddresses: Boolean) : TEditResult;

Method AddAllAddressesToSubnets

Adds all valid IP Addresses to a list of subnets.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetIds TInt64Array
The IDs of the subnets that you want to add IP addresses to.
In ReturnAddedAddresses Boolean
If true, a list of IP addresses that are added are returned in the result.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddAllAddressesToSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array ; const ReturnAddedAddresses: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddAllAddressesToSubnets( String OperationId , TInt64Array SubnetIds , Boolean ReturnAddedAddresses);

Delphi Syntax:

function EasyIPEdit.AddAllAddressesToSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array ; const ReturnAddedAddresses: Boolean) : TEditResult;

Method AddAllChildSubnets

Adds all the child subnets to a subnet using the cidr mask provided.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetIds TInt64Array
The IDs of the subnets that you want to add child subnets to.
In ChildCidr Integer
The cidr mask that will be used for the child subnets.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddAllChildSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array ; const ChildCidr: Integer) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddAllChildSubnets( String OperationId , TInt64Array SubnetIds , Int32 ChildCidr);

Delphi Syntax:

function EasyIPEdit.AddAllChildSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array ; const ChildCidr: Integer) : TEditResult;

Method AddAutonomousNetwork

Adds a new autonomous network. The user that creates the autonomous network will be given full privileges to the new autonomous network. Other users will need to be granted the privileges specifically.

Parameters:

Flag Name Type Description
In Name Widestring
The name of of the new autonomous network.
In Notes WideString
Notes for the autonomous network.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPEdit.AddAutonomousNetwork(const Name: Widestring ; const Notes: WideString) : Int64;

C# Syntax:

public Int64 EasyIPEdit.AddAutonomousNetwork( String Name , WideString Notes);

Delphi Syntax:

function EasyIPEdit.AddAutonomousNetwork(const Name: Widestring ; const Notes: WideString) : Int64;

Method AddChildSubnets

Adds specific child subnets to a subnet.

Parameters:

Flag Name Type Description
In OperationId Widestring
                                                                 The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The ID of the subnet that you want to add the child subnets to.
In ChildSubnets TSubnetsArray
A list of the child subnets that you want to add.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddChildSubnets(const OperationId: Widestring ; const SubnetId: Int64 ; const ChildSubnets: TSubnetsArray) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddChildSubnets( String OperationId , Int64 SubnetId , TSubnetsArray ChildSubnets);

Delphi Syntax:

function EasyIPEdit.AddChildSubnets(const OperationId: Widestring ; const SubnetId: Int64 ; const ChildSubnets: TSubnetsArray) : TEditResult;

Method AddGroup

Adds a new group to an autonomous network or group.

Parameters:

Flag Name Type Description
In AutonomousNetworkId Int64
The ID of the autonomous network that you want to add the group to.
In ParentId Int64
The ID of the group that you want to add the new group to. If this value is 0, the group will be added as a direct child of the autonomous network.
In GroupName Widestring
The name of the new group.
In IPVers TIPVers
If this group defines a range, set IPVers to ivIPv4 or ivIPv6.
In LowAddress Widestring
If this group defines a range, set to the Low Address of the range. Leave as an empty string if you do not want to define a low end for the range.
In HighAddress Widestring
If this group defines a range, set to the High Address of the range. Leave as an empty string if you do not want to define a high end for the range.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddGroup(const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const GroupName: Widestring ; const IPVers: TIPVers ; const LowAddress: Widestring ; const HighAddress: Widestring) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddGroup(Int64 AutonomousNetworkId , Int64 ParentId , String GroupName , TIPVers IPVers , String LowAddress , String HighAddress);

Delphi Syntax:

function EasyIPEdit.AddGroup(const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const GroupName: Widestring ; const IPVers: TIPVers ; const LowAddress: Widestring ; const HighAddress: Widestring) : TEditResult;

Method AddGroups

Adds multiple groups to an autonomous network or group.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The autonomous network ID.
In ParentId Int64
The ID of the parent group. Use 0 if the parent is an autonomous network.
In GroupNames TStringArray
The array of group names.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddGroups(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const GroupNames: TStringArray) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddGroups( String OperationId , Int64 AutonomousNetworkId , Int64 ParentId , TStringArray GroupNames);

Delphi Syntax:

function EasyIPEdit.AddGroups(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const GroupNames: TStringArray) : TEditResult;

Method AddIPAddressLinkDescription

Adds an IP Address link description and returns the new ID.

Parameters:

Flag Name Type Description
In Description WideString
The IP Address link description.

Return Value:

Flag Name Type
Result Result Integer

Oxygene Syntax:

method EasyIPEdit.AddIPAddressLinkDescription(const Description: WideString) : Integer;

C# Syntax:

public Integer EasyIPEdit.AddIPAddressLinkDescription(WideString Description);

Delphi Syntax:

function EasyIPEdit.AddIPAddressLinkDescription(const Description: WideString) : Integer;

Method AddIPAddressLinks

Adds IP address links.

If the first and second ID arrays contain the same number of items, one to one links will be created.
If the first or second array contains a single item and the other array contains multiple items, a one to many relationship will be created.

The link description must already have been created using the AddIPAddressLinkDescription method.

Parameters:

Flag Name Type Description
In IPAddressIDs1 TInt64Array
The first array of IP address IDs.
In IPAddressIDs2 TInt64Array
The second array of IP address IDs.
In LinkDescription WideString
A description for the link relationship.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.AddIPAddressLinks(const IPAddressIDs1: TInt64Array ; const IPAddressIDs2: TInt64Array ; const LinkDescription: WideString);

C# Syntax:

public void EasyIPEdit.AddIPAddressLinks(TInt64Array IPAddressIDs1 , TInt64Array IPAddressIDs2 , WideString LinkDescription);

Delphi Syntax:

procedure EasyIPEdit.AddIPAddressLinks(const IPAddressIDs1: TInt64Array ; const IPAddressIDs2: TInt64Array ; const LinkDescription: WideString) ;

Method AddSubnets

Adds a list of root Subets to a group or autonomous network.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The ID of the parent autonomous network.
In ParentId Int64
The ID of the parent group. This parameter should be 0 if you want the subnet to be a direct child of the autonomous network.
In Subnets TSubnetsArray

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddSubnets(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const Subnets: TSubnetsArray) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddSubnets( String OperationId , Int64 AutonomousNetworkId , Int64 ParentId , TSubnetsArray Subnets);

Delphi Syntax:

function EasyIPEdit.AddSubnets(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ParentId: Int64 ; const Subnets: TSubnetsArray) : TEditResult;

Method AddSubnetsToCorrectParents

Adds a list of subnets to their correct parent subnets. If the subnet does not have a parent, it will be added to the default parent.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkID Int64
The ID of the parent autonomous network.
In DefaultParentID Int64
The ID of the group that a subnet will be added to if it's parent subnt does not exist.
In Subnets TSubnetsArray
An array of the subnets you want to add.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.AddSubnetsToCorrectParents(const OperationID: WideString ; const AutonomousNetworkID: Int64 ; const DefaultParentID: Int64 ; const Subnets: TSubnetsArray) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.AddSubnetsToCorrectParents(WideString OperationID , Int64 AutonomousNetworkID , Int64 DefaultParentID , TSubnetsArray Subnets);

Delphi Syntax:

function EasyIPEdit.AddSubnetsToCorrectParents(const OperationID: WideString ; const AutonomousNetworkID: Int64 ; const DefaultParentID: Int64 ; const Subnets: TSubnetsArray) : TEditResult;

Method ApplyDelta

Applies changes to the user data in the Subnet or Address table.

Parameters:

Flag Name Type Description
In EasyIPDelta TEasyIPDelta
The Delta changes that you want to apply.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.ApplyDelta(const EasyIPDelta: TEasyIPDelta);

C# Syntax:

public void EasyIPEdit.ApplyDelta(TEasyIPDelta EasyIPDelta);

Delphi Syntax:

procedure EasyIPEdit.ApplyDelta(const EasyIPDelta: TEasyIPDelta) ;

Method DeleteAddressesFromSubnets

Delete all the IP Addresses from a list of subnets.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetIds TInt64Array
The list of IDs of the subnets whose IP addresses you want to delete.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.DeleteAddressesFromSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.DeleteAddressesFromSubnets( String OperationId , TInt64Array SubnetIds);

Delphi Syntax:

function EasyIPEdit.DeleteAddressesFromSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array) : TEditResult;

Method DeleteAutonomousNetwork

Deletes an autonomous network. The autonomous network must be empty before you can delete it.

Parameters:

Flag Name Type Description
In Id Int64
The ID of the Autonomous Network that you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.DeleteAutonomousNetwork(const Id: Int64);

C# Syntax:

public void EasyIPEdit.DeleteAutonomousNetwork(Int64 Id);

Delphi Syntax:

procedure EasyIPEdit.DeleteAutonomousNetwork(const Id: Int64) ;

Method DeleteGroupsOrSubnets

Delete groups/subnets.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ItemIds TInt64Array
The IDs of the groups and/or subnets you want to delete.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.DeleteGroupsOrSubnets(const OperationId: Widestring ; const ItemIds: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.DeleteGroupsOrSubnets( String OperationId , TInt64Array ItemIds);

Delphi Syntax:

function EasyIPEdit.DeleteGroupsOrSubnets(const OperationId: Widestring ; const ItemIds: TInt64Array) : TEditResult;

Method DeleteIPAddressesById

Deletes a list of IP addresses.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The ID of the subnet to which the IP addresses belong.
In IPAddressIds TInt64Array
An array of the IDs of the IP addresses you want to delete. All the IP addresses must belong to the same subnet.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.DeleteIPAddressesById(const OperationId: Widestring ; const SubnetId: Int64 ; const IPAddressIds: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.DeleteIPAddressesById( String OperationId , Int64 SubnetId , TInt64Array IPAddressIds);

Delphi Syntax:

function EasyIPEdit.DeleteIPAddressesById(const OperationId: Widestring ; const SubnetId: Int64 ; const IPAddressIds: TInt64Array) : TEditResult;

Method DeleteIPAddressLinks

Deletes IP address links.

Parameters:

Flag Name Type Description
In LinkIDs TInt64Array
An array of the IP Address Link IDs you want to delete.
In IPAddressIDs TInt64Array
An array of the IP Address IDs that are associated with the Link IDs.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.DeleteIPAddressLinks(const LinkIDs: TInt64Array ; const IPAddressIDs: TInt64Array);

C# Syntax:

public void EasyIPEdit.DeleteIPAddressLinks(TInt64Array LinkIDs , TInt64Array IPAddressIDs);

Delphi Syntax:

procedure EasyIPEdit.DeleteIPAddressLinks(const LinkIDs: TInt64Array ; const IPAddressIDs: TInt64Array) ;

Method DeleteSubnetChildren

Deletes the children of subnets. Any IP addresses that belong to the deleted child subnets will be moved to the parent.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ParentSubnetIds TInt64Array
An array of the IDs of the parent subnets whose child subnets you want to delete.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.DeleteSubnetChildren(const OperationId: Widestring ; const ParentSubnetIds: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.DeleteSubnetChildren( String OperationId , TInt64Array ParentSubnetIds);

Delphi Syntax:

function EasyIPEdit.DeleteSubnetChildren(const OperationId: Widestring ; const ParentSubnetIds: TInt64Array) : TEditResult;

Method ImportFromXML

Imports data in an XML format.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In DefaultParentAutonomousNetworkId Int64
The ID of the autonomous network that will be used for groups and subnets that do not have a logical parent.
In DefaultParentGroupId Int64
The ID of the group that will be used for groups and subnets that do not have a logical parent. Use 0 to import directly to the autonomous network.
In XML Widestring
The XML data.
In CreateChildSubnetsWithNoSpecificParent Boolean
Then true, child subnets that do not have a specific parent will be created.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.ImportFromXML(const OperationId: Widestring ; const DefaultParentAutonomousNetworkId: Int64 ; const DefaultParentGroupId: Int64 ; const XML: Widestring ; const CreateChildSubnetsWithNoSpecificParent: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.ImportFromXML( String OperationId , Int64 DefaultParentAutonomousNetworkId , Int64 DefaultParentGroupId , String XML , Boolean CreateChildSubnetsWithNoSpecificParent);

Delphi Syntax:

function EasyIPEdit.ImportFromXML(const OperationId: Widestring ; const DefaultParentAutonomousNetworkId: Int64 ; const DefaultParentGroupId: Int64 ; const XML: Widestring ; const CreateChildSubnetsWithNoSpecificParent: Boolean) : TEditResult;

Method MoveGroupsAndSubnets

Move groups/subnets from one parent to another.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In DestinationAutonomousNetworkId Int64
The ID of the destination autonomous network.
In DestinationId Int64
The ID of the destination group. Use 0 to move as a direct child of the autonomous network.
In IdsToMove TInt64Array
The IDs of the groups/subnets you want to move.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.MoveGroupsAndSubnets(const OperationId: Widestring ; const DestinationAutonomousNetworkId: Int64 ; const DestinationId: Int64 ; const IdsToMove: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.MoveGroupsAndSubnets( String OperationId , Int64 DestinationAutonomousNetworkId , Int64 DestinationId , TInt64Array IdsToMove);

Delphi Syntax:

function EasyIPEdit.MoveGroupsAndSubnets(const OperationId: Widestring ; const DestinationAutonomousNetworkId: Int64 ; const DestinationId: Int64 ; const IdsToMove: TInt64Array) : TEditResult;

Method PasteGroupStructure

Pastes the structure of an existing group hierarchy to a new location.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SrcGroupIds TInt64Array
The IDs of the groups you want to copy.
In DstGroupIds TInt64Array
The IDs of the groups that you want to paste to.
In DstAutonomousNetwork Int64
The ID of the destination autonomous network.
In PreserveRestrictions Boolean
Then true, group restrictions will be preserved.
In PasteUserFields Boolean
When true, user field data will be copied to the new records.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.PasteGroupStructure(const OperationId: WideString ; const SrcGroupIds: TInt64Array ; const DstGroupIds: TInt64Array ; const DstAutonomousNetwork: Int64 ; const PreserveRestrictions: Boolean ; const PasteUserFields: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.PasteGroupStructure(WideString OperationId , TInt64Array SrcGroupIds , TInt64Array DstGroupIds , Int64 DstAutonomousNetwork , Boolean PreserveRestrictions , Boolean PasteUserFields);

Delphi Syntax:

function EasyIPEdit.PasteGroupStructure(const OperationId: WideString ; const SrcGroupIds: TInt64Array ; const DstGroupIds: TInt64Array ; const DstAutonomousNetwork: Int64 ; const PreserveRestrictions: Boolean ; const PasteUserFields: Boolean) : TEditResult;

Method PasteSubnetStructure

Pastes the structure of an existing subnet hierarchy to a new location. The destination subnets must have the sampe IP Address type and CIDR mask as the source subnet.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SrcSubnetId Int64
The ID of the source subnet.
In DstSubnetIds TInt64Array
The IDs of the destination subnets.
In PasteUserFields Boolean
When true, user field data will also be pasted.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.PasteSubnetStructure(const OperationId: WideString ; const SrcSubnetId: Int64 ; const DstSubnetIds: TInt64Array ; const PasteUserFields: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.PasteSubnetStructure(WideString OperationId , Int64 SrcSubnetId , TInt64Array DstSubnetIds , Boolean PasteUserFields);

Delphi Syntax:

function EasyIPEdit.PasteSubnetStructure(const OperationId: WideString ; const SrcSubnetId: Int64 ; const DstSubnetIds: TInt64Array ; const PasteUserFields: Boolean) : TEditResult;

Method RemoveParentSubnets

Removes the parent subnets from the subnet subnets that are defined in SubnetIds

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetIds TInt64Array
The IDs of the subnets whose parents you want to remove.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.RemoveParentSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.RemoveParentSubnets( String OperationId , TInt64Array SubnetIds);

Delphi Syntax:

function EasyIPEdit.RemoveParentSubnets(const OperationId: Widestring ; const SubnetIds: TInt64Array) : TEditResult;

Method ReparentChildSubnets

Adds a new parent subnet between the parent subnet and a number of it's child subnets.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ParentSubnetId Int64
The ID of the parent subnet.
In NewParentSubnet Widestring
The new subnet that will be added as a child of the parent subnet and a parent of the moved child subnets.
In NewParentCidr Integer
The CIDR mask of the new subnet.
In SubnetIdsToMove TInt64Array
The IDs of the children that you want to reparent.
In PreserveChildren Boolean
When true, the child subnets will be moved. When false, the child subnets will be deleted and all their IP addresses moved to the new subnet.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.ReparentChildSubnets(const OperationId: Widestring ; const ParentSubnetId: Int64 ; const NewParentSubnet: Widestring ; const NewParentCidr: Integer ; const SubnetIdsToMove: TInt64Array ; const PreserveChildren: Boolean) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.ReparentChildSubnets( String OperationId , Int64 ParentSubnetId , String NewParentSubnet , Int32 NewParentCidr , TInt64Array SubnetIdsToMove , Boolean PreserveChildren);

Delphi Syntax:

function EasyIPEdit.ReparentChildSubnets(const OperationId: Widestring ; const ParentSubnetId: Int64 ; const NewParentSubnet: Widestring ; const NewParentCidr: Integer ; const SubnetIdsToMove: TInt64Array ; const PreserveChildren: Boolean) : TEditResult;

Method Undo

Undoes the last edit operation.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.Undo(const OperationId: Widestring) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.Undo( String OperationId);

Delphi Syntax:

function EasyIPEdit.Undo(const OperationId: Widestring) : TEditResult;

Method UpdateAutonomousNetwork

Updates the name and notes associated with an autonomous network.

Parameters:

Flag Name Type Description
In Id Int64
The ID of the autonomous network.
In NewName Widestring
The new name for the autonomous network.
In Notes WideString
The notes for the autonomous network.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.UpdateAutonomousNetwork(const Id: Int64 ; const NewName: Widestring ; const Notes: WideString);

C# Syntax:

public void EasyIPEdit.UpdateAutonomousNetwork(Int64 Id , String NewName , WideString Notes);

Delphi Syntax:

procedure EasyIPEdit.UpdateAutonomousNetwork(const Id: Int64 ; const NewName: Widestring ; const Notes: WideString) ;

Method UpdateGroup

Update a group.

Parameters:

Flag Name Type Description
In GroupId Int64
The group ID.
In GroupName Widestring
The new group name.
In IPVers TIPVers
If this is to be a limited group, set the IP version.
In LowAddress Widestring
If this is to be a limited group, set the low IP address.
In HighAddress Widestring
If this is to be a limited group, set the high address.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.UpdateGroup(const GroupId: Int64 ; const GroupName: Widestring ; const IPVers: TIPVers ; const LowAddress: Widestring ; const HighAddress: Widestring) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.UpdateGroup(Int64 GroupId , String GroupName , TIPVers IPVers , String LowAddress , String HighAddress);

Delphi Syntax:

function EasyIPEdit.UpdateGroup(const GroupId: Int64 ; const GroupName: Widestring ; const IPVers: TIPVers ; const LowAddress: Widestring ; const HighAddress: Widestring) : TEditResult;

Method UpdateUserFields

Updates the values of specific user data fields.

Parameters:

Flag Name Type Description
In TableName WideString
The name of the table to which the fields belong.
In KeyId Int64
The ID of the record you want to update.
In FieldNames TStringArray
The names of the fields you want to update.
In FieldValues TVarArray
The new values of the fields.

Return Value:

None.

Oxygene Syntax:

method EasyIPEdit.UpdateUserFields(const TableName: WideString ; const KeyId: Int64 ; const FieldNames: TStringArray ; const FieldValues: TVarArray);

C# Syntax:

public void EasyIPEdit.UpdateUserFields(WideString TableName , Int64 KeyId , TStringArray FieldNames , TVarArray FieldValues);

Delphi Syntax:

procedure EasyIPEdit.UpdateUserFields(const TableName: WideString ; const KeyId: Int64 ; const FieldNames: TStringArray ; const FieldValues: TVarArray) ;

Method CreateNextAvailableIPAddress

Creates the next available IP address in a subnet and returns its ID. If UpdateFieldName has a value it will be updated with the value in UpdateFieldValue.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetID Int64
The ID of the subnet that you want to create the IP address in.
In UpdateFieldName WideString
If this variable has a value, Easy-IP will update the field with the value in UpdateFieldValue.
In UpdateFieldValue WideString
The value that will be entered in the field identified by the UpdateFieldName parameter.
Out IPAddressID Int64
The ID of the IP Address that has been created.

Return Value:

Flag Name Type
Result Result TEditResult

Oxygene Syntax:

method EasyIPEdit.CreateNextAvailableIPAddress(const OperationID: WideString ; const SubnetID: Int64 ; const UpdateFieldName: WideString ; const UpdateFieldValue: WideString ; IPAddressID: Int64) : TEditResult;

C# Syntax:

public TEditResult EasyIPEdit.CreateNextAvailableIPAddress(WideString OperationID , Int64 SubnetID , WideString UpdateFieldName , WideString UpdateFieldValue , out Int64 IPAddressID);

Delphi Syntax:

function EasyIPEdit.CreateNextAvailableIPAddress(const OperationID: WideString ; const SubnetID: Int64 ; const UpdateFieldName: WideString ; const UpdateFieldValue: WideString ; IPAddressID: Int64) : TEditResult;

Method ReserveNextAvailableIPAddress

Sets the value of a field in the first matching IP address record. The IP Address ID is returned.

Parameters:

Flag Name Type Description
In SubnetID Int64
The ID of the subnet that you want to reserve the IP address in.
In ComparisonFieldName WideString
The first IP address that has a fieldname matching this parameter and a value matching the ComparisionFieldValue will be returned.
In ComparisonFieldValue WideString
The first IP address that has a fieldname matching the ComparisonFieldName parameter and a value matching this parameter will be returned.
In UpdateFieldName WideString
If this variable has a value, Easy-IP will update the field with the value in UpdateFieldValue.
In UpdateFieldValue WideString
The value that will be entered in the field identified by the UpdateFieldName parameter.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPEdit.ReserveNextAvailableIPAddress(const SubnetID: Int64 ; const ComparisonFieldName: WideString ; const ComparisonFieldValue: WideString ; const UpdateFieldName: WideString ; const UpdateFieldValue: WideString) : Int64;

C# Syntax:

public Int64 EasyIPEdit.ReserveNextAvailableIPAddress(Int64 SubnetID , WideString ComparisonFieldName , WideString ComparisonFieldValue , WideString UpdateFieldName , WideString UpdateFieldValue);

Delphi Syntax:

function EasyIPEdit.ReserveNextAvailableIPAddress(const SubnetID: Int64 ; const ComparisonFieldName: WideString ; const ComparisonFieldValue: WideString ; const UpdateFieldName: WideString ; const UpdateFieldValue: WideString) : Int64;
Service LocalService

The following table lists the Operations defined in "LocalService":

UpdateDatabaseMetaData

GetUserTables

GetUserFields

ImportDefaultFiles

UpdateFTSRecords

CancelQuery

GetDatabaseServerVersion

UpdateMACAddressData

Method UpdateDatabaseMetaData


Parameters:

Flag Name Type Description
Out OldDatabaseVersion Integer

Out NewDatabaseVersion Integer

Return Value:

None.

Oxygene Syntax:

method LocalService.UpdateDatabaseMetaData(OldDatabaseVersion: Integer ; NewDatabaseVersion: Integer);

C# Syntax:

public void LocalService.UpdateDatabaseMetaData(out Int32 OldDatabaseVersion , out Int32 NewDatabaseVersion);

Delphi Syntax:

procedure LocalService.UpdateDatabaseMetaData(OldDatabaseVersion: Integer ; NewDatabaseVersion: Integer) ;

Method GetUserTables


Parameters:

Flag Name Type Description
In IncludeHidden Boolean

In IncludeExtendedAttributes Boolean

Return Value:

Flag Name Type
Result Result TUserTables

Oxygene Syntax:

method LocalService.GetUserTables(const IncludeHidden: Boolean ; const IncludeExtendedAttributes: Boolean) : TUserTables;

C# Syntax:

public TUserTables LocalService.GetUserTables(Boolean IncludeHidden , Boolean IncludeExtendedAttributes);

Delphi Syntax:

function LocalService.GetUserTables(const IncludeHidden: Boolean ; const IncludeExtendedAttributes: Boolean) : TUserTables;

Method GetUserFields


Parameters:

Flag Name Type Description
In TableName Widestring

Return Value:

Flag Name Type
Result Result TUserFields

Oxygene Syntax:

method LocalService.GetUserFields(const TableName: Widestring) : TUserFields;

C# Syntax:

public TUserFields LocalService.GetUserFields( String TableName);

Delphi Syntax:

function LocalService.GetUserFields(const TableName: Widestring) : TUserFields;

Method ImportDefaultFiles


Parameters:

None.

Return Value:

None.

Oxygene Syntax:

method LocalService.ImportDefaultFiles();

C# Syntax:

public void LocalService.ImportDefaultFiles();

Delphi Syntax:

procedure LocalService.ImportDefaultFiles() ;

Method UpdateFTSRecords


Parameters:

Flag Name Type Description
In UpdateTimestamp DateTime

In MaximumRecords Integer

In MaximumWorkingMilliSeconds Integer

Out Error WideString

Out UpdateCount Integer

Return Value:

None.

Oxygene Syntax:

method LocalService.UpdateFTSRecords(const UpdateTimestamp: DateTime ; const MaximumRecords: Integer ; const MaximumWorkingMilliSeconds: Integer ; Error: WideString ; UpdateCount: Integer);

C# Syntax:

public void LocalService.UpdateFTSRecords(DateTime UpdateTimestamp , Int32 MaximumRecords , Int32 MaximumWorkingMilliSeconds , out WideString Error , out Int32 UpdateCount);

Delphi Syntax:

procedure LocalService.UpdateFTSRecords(const UpdateTimestamp: DateTime ; const MaximumRecords: Integer ; const MaximumWorkingMilliSeconds: Integer ; Error: WideString ; UpdateCount: Integer) ;

Method CancelQuery


Parameters:

Flag Name Type Description
In AttachmentID Integer

Return Value:

None.

Oxygene Syntax:

method LocalService.CancelQuery(const AttachmentID: Integer);

C# Syntax:

public void LocalService.CancelQuery( Int32 AttachmentID);

Delphi Syntax:

procedure LocalService.CancelQuery(const AttachmentID: Integer) ;

Method GetDatabaseServerVersion


Parameters:

Flag Name Type Description
Out MajorVersion Integer

Out MinorVersion Integer

Out PointVersion Integer

Return Value:

None.

Oxygene Syntax:

method LocalService.GetDatabaseServerVersion(MajorVersion: Integer ; MinorVersion: Integer ; PointVersion: Integer);

C# Syntax:

public void LocalService.GetDatabaseServerVersion(out Int32 MajorVersion , out Int32 MinorVersion , out Int32 PointVersion);

Delphi Syntax:

procedure LocalService.GetDatabaseServerVersion(MajorVersion: Integer ; MinorVersion: Integer ; PointVersion: Integer) ;

Method UpdateMACAddressData


Parameters:

None.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method LocalService.UpdateMACAddressData() : Boolean;

C# Syntax:

public Boolean LocalService.UpdateMACAddressData();

Delphi Syntax:

function LocalService.UpdateMACAddressData() : Boolean;
Service BaseEasyIPService

The following table lists the Operations defined in "BaseEasyIPService":

Service EasyIPTools

The following table lists the Operations defined in "EasyIPTools":

CheckTemplateParameters
Verifies the validity of the template parameters.
CompileScript
(Deprecated, use CompileTemplateValidationScript)

Compiles a template script.
CompileScript2

CopyTrees
Returns the subnet tree of a list of subnets.
ExecuteTemplate
Executes a template and returns the result.
ExecuteTemplate2

ExportToCSV
Exports a portion of the subnet tree as CSV.
ExportToHTML
Exports a portion of the subnet tree as HTML.
ExportToXML
Exports a portion of the subnet tree to XML.
GenerateDefaultValues
Generates the default parameter values for a template script.
GenerateDefaultValues2

GetMissingSubnets
Returns a list of missing subnets within a range.
GetTemplateScriptHelp

Method CheckTemplateParameters

Verifies the validity of the template parameters.

Parameters:

Flag Name Type Description
In Parameters TTemplateParameters
The template parameters that you want to check.

Return Value:

None.

Oxygene Syntax:

method EasyIPTools.CheckTemplateParameters(const Parameters: TTemplateParameters);

C# Syntax:

public void EasyIPTools.CheckTemplateParameters(TTemplateParameters Parameters);

Delphi Syntax:

procedure EasyIPTools.CheckTemplateParameters(const Parameters: TTemplateParameters) ;

Method CompileScript

(Deprecated, use CompileTemplateValidationScript)

Compiles a template script.

Parameters:

Flag Name Type Description
In TemplateScript TTemplateScript
The template script that you want to compile.
Out ErrorX Integer
If an error occurs, this parameter returns it's x co-ordinate.
Out ErrorY Integer
If an error occurs, this parameter returns it's y co-ordinate.
Out Log Widestring
The template execution log.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPTools.CompileScript(const TemplateScript: TTemplateScript ; ErrorX: Integer ; ErrorY: Integer ; Log: Widestring) : Boolean;

C# Syntax:

public Boolean EasyIPTools.CompileScript(TTemplateScript TemplateScript , out Int32 ErrorX , out Int32 ErrorY , out String Log);

Delphi Syntax:

function EasyIPTools.CompileScript(const TemplateScript: TTemplateScript ; ErrorX: Integer ; ErrorY: Integer ; Log: Widestring) : Boolean;

Method CompileScript2


Parameters:

Flag Name Type Description
In TemplateScript TTemplateScript2

Out ErrorX Integer

Out ErrorY Integer

Out Log WideString

Out ErrorMessage WideString

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPTools.CompileScript2(const TemplateScript: TTemplateScript2 ; ErrorX: Integer ; ErrorY: Integer ; Log: WideString ; ErrorMessage: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPTools.CompileScript2(TTemplateScript2 TemplateScript , out Int32 ErrorX , out Int32 ErrorY , out WideString Log , out WideString ErrorMessage);

Delphi Syntax:

function EasyIPTools.CompileScript2(const TemplateScript: TTemplateScript2 ; ErrorX: Integer ; ErrorY: Integer ; Log: WideString ; ErrorMessage: WideString) : Boolean;

Method CopyTrees

Returns the subnet tree of a list of subnets.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ItemIDs TSubnetIds
The subnet IDs.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPTools.CopyTrees(const OperationId: WideString ; const ItemIDs: TSubnetIds) : WideString;

C# Syntax:

public WideString EasyIPTools.CopyTrees(WideString OperationId , TSubnetIds ItemIDs);

Delphi Syntax:

function EasyIPTools.CopyTrees(const OperationId: WideString ; const ItemIDs: TSubnetIds) : WideString;

Method ExecuteTemplate

Executes a template and returns the result.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In TemplateScript TTemplateScript
The script that you want to execute.
In ItemIds TInt64Array
The IDs of the items that you want to execute the template on.
In IPAddressIds TInt64Array
The IDs of the IP addresses that you want to execute the template on.
Out Log Widestring
The template execution log.

Return Value:

Flag Name Type
Result Result Widestring

Oxygene Syntax:

method EasyIPTools.ExecuteTemplate(const OperationId: Widestring ; const TemplateScript: TTemplateScript ; const ItemIds: TInt64Array ; const IPAddressIds: TInt64Array ; Log: Widestring) : Widestring;

C# Syntax:

public Widestring EasyIPTools.ExecuteTemplate( String OperationId , TTemplateScript TemplateScript , TInt64Array ItemIds , TInt64Array IPAddressIds , out String Log);

Delphi Syntax:

function EasyIPTools.ExecuteTemplate(const OperationId: Widestring ; const TemplateScript: TTemplateScript ; const ItemIds: TInt64Array ; const IPAddressIds: TInt64Array ; Log: Widestring) : Widestring;

Method ExecuteTemplate2


Parameters:

Flag Name Type Description
In OperationID WideString

In TemplateScript TTemplateScript2

In AutonomousNetworkID Int64

In ItemIDs TInt64Array

In IPAddressIDs TInt64Array

Out Log WideString

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPTools.ExecuteTemplate2(const OperationID: WideString ; const TemplateScript: TTemplateScript2 ; const AutonomousNetworkID: Int64 ; const ItemIDs: TInt64Array ; const IPAddressIDs: TInt64Array ; Log: WideString) : WideString;

C# Syntax:

public WideString EasyIPTools.ExecuteTemplate2(WideString OperationID , TTemplateScript2 TemplateScript , Int64 AutonomousNetworkID , TInt64Array ItemIDs , TInt64Array IPAddressIDs , out WideString Log);

Delphi Syntax:

function EasyIPTools.ExecuteTemplate2(const OperationID: WideString ; const TemplateScript: TTemplateScript2 ; const AutonomousNetworkID: Int64 ; const ItemIDs: TInt64Array ; const IPAddressIDs: TInt64Array ; Log: WideString) : WideString;

Method ExportToCSV

Exports a portion of the subnet tree as CSV.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The autonomous network ID.
In ItemIds TInt64Array
An array of the IDs of the groups and/or subnets you want to export.
In TableName WideString
The name of the table you want to export (SUBNETS | ADDRESSES)
In AllFields Boolean
When true, system fields will be exported.
In IncludeChildren Boolean
When checked, the children of the groups/subnets will also be exported.
In QuoteCharacter WideString
The character to be used as a quote.
In Delimiter WideString
The character to be used as the delimiter.
In EOL WideString
The end of line string.
In IncludeColumnHeaders Boolean
When true, column headers will be included.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPTools.ExportToCSV(const OperationId: WideString ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const TableName: WideString ; const AllFields: Boolean ; const IncludeChildren: Boolean ; const QuoteCharacter: WideString ; const Delimiter: WideString ; const EOL: WideString ; const IncludeColumnHeaders: Boolean) : WideString;

C# Syntax:

public WideString EasyIPTools.ExportToCSV(WideString OperationId , Int64 AutonomousNetworkId , TInt64Array ItemIds , WideString TableName , Boolean AllFields , Boolean IncludeChildren , WideString QuoteCharacter , WideString Delimiter , WideString EOL , Boolean IncludeColumnHeaders);

Delphi Syntax:

function EasyIPTools.ExportToCSV(const OperationId: WideString ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const TableName: WideString ; const AllFields: Boolean ; const IncludeChildren: Boolean ; const QuoteCharacter: WideString ; const Delimiter: WideString ; const EOL: WideString ; const IncludeColumnHeaders: Boolean) : WideString;

Method ExportToHTML

Exports a portion of the subnet tree as HTML.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The autonomous network ID.
In ItemIds TInt64Array
An array of the IDs of the groups and/or subnets you want to export.
In TableName WideString
The name of the table you want to export (SUBNETS | ADDRESSES)
In AllFields Boolean
When true, system fields will be exported.
In IncludeChildren Boolean
When checked, the children of the groups/subnets will also be exported.
In IncludeColumnHeaders Boolean
When true, column headers will be included.
In AddTableBorders Boolean
When true, table will include borders.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPTools.ExportToHTML(const OperationId: WideString ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const TableName: WideString ; const AllFields: Boolean ; const IncludeChildren: Boolean ; const IncludeColumnHeaders: Boolean ; const AddTableBorders: Boolean) : WideString;

C# Syntax:

public WideString EasyIPTools.ExportToHTML(WideString OperationId , Int64 AutonomousNetworkId , TInt64Array ItemIds , WideString TableName , Boolean AllFields , Boolean IncludeChildren , Boolean IncludeColumnHeaders , Boolean AddTableBorders);

Delphi Syntax:

function EasyIPTools.ExportToHTML(const OperationId: WideString ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const TableName: WideString ; const AllFields: Boolean ; const IncludeChildren: Boolean ; const IncludeColumnHeaders: Boolean ; const AddTableBorders: Boolean) : WideString;

Method ExportToXML

Exports a portion of the subnet tree to XML.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The autonomous network ID.
In ItemIds TInt64Array
An array of the IDs of the groups and/or subnets you want to export.
In IncludeIPAddresses Boolean
When true, IP addresses will be included in the export.
In AllFields Boolean
When true, system fields will be exported.
In UseIds Boolean
When true, field IDs will be used instead of field names.
In IncludeChildren Boolean
When checked, the children of the groups/subnets will also be exported.
In Compress Boolean
When true, the xml will be compressed.

Return Value:

Flag Name Type
Result Result Widestring

Oxygene Syntax:

method EasyIPTools.ExportToXML(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const IncludeIPAddresses: Boolean ; const AllFields: Boolean ; const UseIds: Boolean ; const IncludeChildren: Boolean ; const Compress: Boolean) : Widestring;

C# Syntax:

public Widestring EasyIPTools.ExportToXML( String OperationId , Int64 AutonomousNetworkId , TInt64Array ItemIds , Boolean IncludeIPAddresses , Boolean AllFields , Boolean UseIds , Boolean IncludeChildren , Boolean Compress);

Delphi Syntax:

function EasyIPTools.ExportToXML(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const ItemIds: TInt64Array ; const IncludeIPAddresses: Boolean ; const AllFields: Boolean ; const UseIds: Boolean ; const IncludeChildren: Boolean ; const Compress: Boolean) : Widestring;

Method GenerateDefaultValues

Generates the default parameter values for a template script.

Parameters:

Flag Name Type Description
In TemplateScript TTemplateScript
The template script.
In AutonomousNetworkId Int64
The ID of the autonomous network.
In ItemId Int64
The ID of the group or subnet.
In IPAddressId Int64
The ID of the IP address.
Out UpdatedParameters TTemplateParameters
Returns the updated parameters.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPTools.GenerateDefaultValues(const TemplateScript: TTemplateScript ; const AutonomousNetworkId: Int64 ; const ItemId: Int64 ; const IPAddressId: Int64 ; UpdatedParameters: TTemplateParameters) : Boolean;

C# Syntax:

public Boolean EasyIPTools.GenerateDefaultValues(TTemplateScript TemplateScript , Int64 AutonomousNetworkId , Int64 ItemId , Int64 IPAddressId , out TTemplateParameters UpdatedParameters);

Delphi Syntax:

function EasyIPTools.GenerateDefaultValues(const TemplateScript: TTemplateScript ; const AutonomousNetworkId: Int64 ; const ItemId: Int64 ; const IPAddressId: Int64 ; UpdatedParameters: TTemplateParameters) : Boolean;

Method GenerateDefaultValues2


Parameters:

Flag Name Type Description
In TemplateScript TTemplateScript2

In AutonomousNetworkID Int64

In ItemID Int64

In IPAddressID Int64

Out UpdatedParameters TTemplateParameters

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPTools.GenerateDefaultValues2(const TemplateScript: TTemplateScript2 ; const AutonomousNetworkID: Int64 ; const ItemID: Int64 ; const IPAddressID: Int64 ; UpdatedParameters: TTemplateParameters) : Boolean;

C# Syntax:

public Boolean EasyIPTools.GenerateDefaultValues2(TTemplateScript2 TemplateScript , Int64 AutonomousNetworkID , Int64 ItemID , Int64 IPAddressID , out TTemplateParameters UpdatedParameters);

Delphi Syntax:

function EasyIPTools.GenerateDefaultValues2(const TemplateScript: TTemplateScript2 ; const AutonomousNetworkID: Int64 ; const ItemID: Int64 ; const IPAddressID: Int64 ; UpdatedParameters: TTemplateParameters) : Boolean;

Method GetMissingSubnets

Returns a list of missing subnets within a range.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.                                                                        The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In AutonomousNetworkId Int64
The autonomous network ID.
In LowIPAddress Widestring
The low IP address of the range.
In HighIPAddress Widestring
The high IP address of the range.
In MinCIDR Integer
The minimum CIDR mask that can be used to generate the missing subnets.
In MaxCIDR Integer
The maximum CIDR mask that can be used to generate the missing subnets.
In ParentId Int64
If you want to find the missing children of a specific subnet, include the ID of the parent subnet.

Return Value:

Flag Name Type
Result Result TMissingSubnets

Oxygene Syntax:

method EasyIPTools.GetMissingSubnets(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const LowIPAddress: Widestring ; const HighIPAddress: Widestring ; const MinCIDR: Integer ; const MaxCIDR: Integer ; const ParentId: Int64) : TMissingSubnets;

C# Syntax:

public TMissingSubnets EasyIPTools.GetMissingSubnets( String OperationId , Int64 AutonomousNetworkId , String LowIPAddress , String HighIPAddress , Int32 MinCIDR , Int32 MaxCIDR , Int64 ParentId);

Delphi Syntax:

function EasyIPTools.GetMissingSubnets(const OperationId: Widestring ; const AutonomousNetworkId: Int64 ; const LowIPAddress: Widestring ; const HighIPAddress: Widestring ; const MinCIDR: Integer ; const MaxCIDR: Integer ; const ParentId: Int64) : TMissingSubnets;

Method GetTemplateScriptHelp


Parameters:

None.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPTools.GetTemplateScriptHelp() : WideString;

C# Syntax:

public WideString EasyIPTools.GetTemplateScriptHelp();

Delphi Syntax:

function EasyIPTools.GetTemplateScriptHelp() : WideString;
Service EasyIPDiscovery

The following table lists the Operations defined in "EasyIPDiscovery":

GetDiscoverableSubnets
Returns an array of subnets that are discoverable.
GetHostDiscoverySubnetIPAddresses
Returns a DiscoveryData object that contains data for the IP Addresses attached to the subnet whose Subnet ID is provided. The DiscoveryData should be updated and passed back to the UpdateDiscoveryData method in order to update the database.
GetHostDiscoveryIPAddresses
Returns a DiscoveryData object that contains data for the IP Addresses whose IDs are contained in the IPAddressIds array. The DiscoveryData should be updated and passed back to the UpdateDiscoveryData method in order to update the database.
UpdateDiscoveryData
Updates the database with the data contained in the DiscoveryData parameter.
BotGetDiscoverableSubnets
Returns a list of subnets that the discovery bot needs to discover. If the list is empty, there are no currently queued discoveries for this discovery bot.
BotUpdateDiscoveryProgress
Sends the progress of a bot discovery to the server.
BotUpdateDiscoveryStatus
Send the status of the bot discovery to the server.
BotCancelDiscovery
Cancels the bot discovery that matches the Discovery ID.
QueueDiscovery
Adds a new discovery to the discovery bot queue.
GetDiscoveryBots
Returns a list of available discovery bots.
GetQueuedDiscoveries
Returns a list of discoveries that are attached to a particular discovery bot.
DeleteQueuedDiscovery
Deletes a queued discovery.
GetUserQueuedDiscoveries
Returns a list of discoveries that have been intiated by the user attached to the current session.
GetDiscoveryLog
Returns the discovery log for a particular discovery.

Method GetDiscoverableSubnets

Returns an array of subnets that are discoverable.

Parameters:

Flag Name Type Description
In ItemIds TSubnetIds
The subnets IDs that you want to use as a base for the discovery.
In IncludeChildren Boolean
When TRUE, the child subnets of the subnets identified by the subnet IDs will be included.
In IPAddressesOnly Boolean
When TRUE, only subnets that have IP addresses will be returned.

Return Value:

Flag Name Type
Result Result TDiscoverableSubnets

Oxygene Syntax:

method EasyIPDiscovery.GetDiscoverableSubnets(const ItemIds: TSubnetIds ; const IncludeChildren: Boolean ; const IPAddressesOnly: Boolean) : TDiscoverableSubnets;

C# Syntax:

public TDiscoverableSubnets EasyIPDiscovery.GetDiscoverableSubnets(TSubnetIds ItemIds , Boolean IncludeChildren , Boolean IPAddressesOnly);

Delphi Syntax:

function EasyIPDiscovery.GetDiscoverableSubnets(const ItemIds: TSubnetIds ; const IncludeChildren: Boolean ; const IPAddressesOnly: Boolean) : TDiscoverableSubnets;

Method GetHostDiscoverySubnetIPAddresses

Returns a DiscoveryData object that contains data for the IP Addresses attached to the subnet whose Subnet ID is provided. The DiscoveryData should be updated and passed back to the UpdateDiscoveryData method in order to update the database.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The Subnet ID of the subnet whose IP Addresses you want to return.
In SkipPastIPAddress WideString
Use this parameter to define which IP address should be skipped. The first IP address DiscoveryData that is returned will be for the first IP Address after the one defined here. If the field is left empty, DiscoveryData will start at the first IP Address in the subnet.
In Count Integer
The number of IP Address items to return.
In OnlyExistingIPAddresses Boolean
When true, only IP Addresses that already exist in the database will be returned.

Return Value:

Flag Name Type
Result Result TDiscoveryData

Oxygene Syntax:

method EasyIPDiscovery.GetHostDiscoverySubnetIPAddresses(const OperationId: WideString ; const SubnetId: Int64 ; const SkipPastIPAddress: WideString ; const Count: Integer ; const OnlyExistingIPAddresses: Boolean) : TDiscoveryData;

C# Syntax:

public TDiscoveryData EasyIPDiscovery.GetHostDiscoverySubnetIPAddresses(WideString OperationId , Int64 SubnetId , WideString SkipPastIPAddress , Int32 Count , Boolean OnlyExistingIPAddresses);

Delphi Syntax:

function EasyIPDiscovery.GetHostDiscoverySubnetIPAddresses(const OperationId: WideString ; const SubnetId: Int64 ; const SkipPastIPAddress: WideString ; const Count: Integer ; const OnlyExistingIPAddresses: Boolean) : TDiscoveryData;

Method GetHostDiscoveryIPAddresses

Returns a DiscoveryData object that contains data for the IP Addresses whose IDs are contained in the IPAddressIds array. The DiscoveryData should be updated and passed back to the UpdateDiscoveryData method in order to update the database.

Parameters:

Flag Name Type Description
In OperationId WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In SubnetId Int64
The ID of the subnet to which the IP Address IDs belong.
In IPAddressIds TInt64Array
The IDs of the IP Addresses that you want to return.

Return Value:

Flag Name Type
Result Result TDiscoveryData

Oxygene Syntax:

method EasyIPDiscovery.GetHostDiscoveryIPAddresses(const OperationId: WideString ; const SubnetId: Int64 ; const IPAddressIds: TInt64Array) : TDiscoveryData;

C# Syntax:

public TDiscoveryData EasyIPDiscovery.GetHostDiscoveryIPAddresses(WideString OperationId , Int64 SubnetId , TInt64Array IPAddressIds);

Delphi Syntax:

function EasyIPDiscovery.GetHostDiscoveryIPAddresses(const OperationId: WideString ; const SubnetId: Int64 ; const IPAddressIds: TInt64Array) : TDiscoveryData;

Method UpdateDiscoveryData

Updates the database with the data contained in the DiscoveryData parameter.

Parameters:

Flag Name Type Description
In OperationId Widestring
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In DiscoveryData TDiscoveryData
The IP Address updates that will be applied to the database.
In UndoId Int64
The Undo ID for the current discovery. If this parameter is set to 0, a new Undo ID will be generated.

Return Value:

Flag Name Type
Result Result TDiscoveryUpdateResult

Oxygene Syntax:

method EasyIPDiscovery.UpdateDiscoveryData(const OperationId: Widestring ; const DiscoveryData: TDiscoveryData ; const UndoId: Int64) : TDiscoveryUpdateResult;

C# Syntax:

public TDiscoveryUpdateResult EasyIPDiscovery.UpdateDiscoveryData( String OperationId , TDiscoveryData DiscoveryData , Int64 UndoId);

Delphi Syntax:

function EasyIPDiscovery.UpdateDiscoveryData(const OperationId: Widestring ; const DiscoveryData: TDiscoveryData ; const UndoId: Int64) : TDiscoveryUpdateResult;

Method BotGetDiscoverableSubnets

Returns a list of subnets that the discovery bot needs to discover. If the list is empty, there are no currently queued discoveries for this discovery bot.

Parameters:

Flag Name Type Description
In IPAddressesOnly Boolean
When true, only existing IP Addresses will be discovered.

Return Value:

Flag Name Type
Result Result TDiscoverableSubnets

Oxygene Syntax:

method EasyIPDiscovery.BotGetDiscoverableSubnets(const IPAddressesOnly: Boolean) : TDiscoverableSubnets;

C# Syntax:

public TDiscoverableSubnets EasyIPDiscovery.BotGetDiscoverableSubnets(Boolean IPAddressesOnly);

Delphi Syntax:

function EasyIPDiscovery.BotGetDiscoverableSubnets(const IPAddressesOnly: Boolean) : TDiscoverableSubnets;

Method BotUpdateDiscoveryProgress

Sends the progress of a bot discovery to the server.

Parameters:

Flag Name Type Description
In ProgressPos Integer
The progress position.
In ProgressMax Integer
The maximum progress.
In LogText WideString
The log text. This should only be set for the last progress update of the discovery.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPDiscovery.BotUpdateDiscoveryProgress(const ProgressPos: Integer ; const ProgressMax: Integer ; const LogText: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPDiscovery.BotUpdateDiscoveryProgress( Int32 ProgressPos , Int32 ProgressMax , WideString LogText);

Delphi Syntax:

function EasyIPDiscovery.BotUpdateDiscoveryProgress(const ProgressPos: Integer ; const ProgressMax: Integer ; const LogText: WideString) : Boolean;

Method BotUpdateDiscoveryStatus

Send the status of the bot discovery to the server.

Parameters:

Flag Name Type Description
In DiscoveryStatus TDiscoveryStatus
The current status of the bot discovery.

Return Value:

None.

Oxygene Syntax:

method EasyIPDiscovery.BotUpdateDiscoveryStatus(const DiscoveryStatus: TDiscoveryStatus);

C# Syntax:

public void EasyIPDiscovery.BotUpdateDiscoveryStatus(TDiscoveryStatus DiscoveryStatus);

Delphi Syntax:

procedure EasyIPDiscovery.BotUpdateDiscoveryStatus(const DiscoveryStatus: TDiscoveryStatus) ;

Method BotCancelDiscovery

Cancels the bot discovery that matches the Discovery ID.

Parameters:

Flag Name Type Description
In DiscoveryId Int64
The ID of the bot discovery you want to cancel.

Return Value:

None.

Oxygene Syntax:

method EasyIPDiscovery.BotCancelDiscovery(const DiscoveryId: Int64);

C# Syntax:

public void EasyIPDiscovery.BotCancelDiscovery(Int64 DiscoveryId);

Delphi Syntax:

procedure EasyIPDiscovery.BotCancelDiscovery(const DiscoveryId: Int64) ;

Method QueueDiscovery

Adds a new discovery to the discovery bot queue.

Parameters:

Flag Name Type Description
In DiscoveryBotId Int64
The ID of the discovery bot that you want to execute the discovery on.
In DiscoveryScriptFilename WideString
The virtual filename of the discovery script you want to execute.
In DiscoveryIds TSubnetIds
The subnets that you want to discover.
In ScheduledRunTime DateTime
The time you want the discovery to run.
In ScheduledRunFrequency TScheduleEventFrequencyType
The frequency that you want the discovery to run. Currently not supported.

Return Value:

Flag Name Type
Result Result Int64

Oxygene Syntax:

method EasyIPDiscovery.QueueDiscovery(const DiscoveryBotId: Int64 ; const DiscoveryScriptFilename: WideString ; const DiscoveryIds: TSubnetIds ; const ScheduledRunTime: DateTime ; const ScheduledRunFrequency: TScheduleEventFrequencyType) : Int64;

C# Syntax:

public Int64 EasyIPDiscovery.QueueDiscovery(Int64 DiscoveryBotId , WideString DiscoveryScriptFilename , TSubnetIds DiscoveryIds , DateTime ScheduledRunTime , TScheduleEventFrequencyType ScheduledRunFrequency);

Delphi Syntax:

function EasyIPDiscovery.QueueDiscovery(const DiscoveryBotId: Int64 ; const DiscoveryScriptFilename: WideString ; const DiscoveryIds: TSubnetIds ; const ScheduledRunTime: DateTime ; const ScheduledRunFrequency: TScheduleEventFrequencyType) : Int64;

Method GetDiscoveryBots

Returns a list of available discovery bots.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TDiscoveryBots

Oxygene Syntax:

method EasyIPDiscovery.GetDiscoveryBots() : TDiscoveryBots;

C# Syntax:

public TDiscoveryBots EasyIPDiscovery.GetDiscoveryBots();

Delphi Syntax:

function EasyIPDiscovery.GetDiscoveryBots() : TDiscoveryBots;

Method GetQueuedDiscoveries

Returns a list of discoveries that are attached to a particular discovery bot.

Parameters:

Flag Name Type Description
In DiscoveryBotId Int64
The ID of the discovery bot whose discoveries you want to return.

Return Value:

Flag Name Type
Result Result TQueuedDiscoveries

Oxygene Syntax:

method EasyIPDiscovery.GetQueuedDiscoveries(const DiscoveryBotId: Int64) : TQueuedDiscoveries;

C# Syntax:

public TQueuedDiscoveries EasyIPDiscovery.GetQueuedDiscoveries(Int64 DiscoveryBotId);

Delphi Syntax:

function EasyIPDiscovery.GetQueuedDiscoveries(const DiscoveryBotId: Int64) : TQueuedDiscoveries;

Method DeleteQueuedDiscovery

Deletes a queued discovery.

Parameters:

Flag Name Type Description
In DiscoveryId Int64
The ID of the discovery that you want to delete.

Return Value:

None.

Oxygene Syntax:

method EasyIPDiscovery.DeleteQueuedDiscovery(const DiscoveryId: Int64);

C# Syntax:

public void EasyIPDiscovery.DeleteQueuedDiscovery(Int64 DiscoveryId);

Delphi Syntax:

procedure EasyIPDiscovery.DeleteQueuedDiscovery(const DiscoveryId: Int64) ;

Method GetUserQueuedDiscoveries

Returns a list of discoveries that have been intiated by the user attached to the current session.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TQueuedDiscoveries

Oxygene Syntax:

method EasyIPDiscovery.GetUserQueuedDiscoveries() : TQueuedDiscoveries;

C# Syntax:

public TQueuedDiscoveries EasyIPDiscovery.GetUserQueuedDiscoveries();

Delphi Syntax:

function EasyIPDiscovery.GetUserQueuedDiscoveries() : TQueuedDiscoveries;

Method GetDiscoveryLog

Returns the discovery log for a particular discovery.

Parameters:

Flag Name Type Description
In DiscoveryId Int64
The ID of the discovery log you want to return.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPDiscovery.GetDiscoveryLog(const DiscoveryId: Int64) : WideString;

C# Syntax:

public WideString EasyIPDiscovery.GetDiscoveryLog(Int64 DiscoveryId);

Delphi Syntax:

function EasyIPDiscovery.GetDiscoveryLog(const DiscoveryId: Int64) : WideString;
Service EasyIPReport

The following table lists the Operations defined in "EasyIPReport":

ExecuteQuery
Executes a database query and returns the results in a binary format. Only SELECT queries are allowed.
ExecuteQuery2
Executes a database query and returns the results as simple data. Only SELECT queries are allowed.
ExportQuery
Exports a query to the specified format.
ExportQueryAndEmail
Exports a query, then emails it to the specified recipient.
GenerateReport
Generates a report. A GUID string is returned. Pass the GUID to the GetDownloadFileSize and GetDownloadFilePart methods (EasyIPService) to retrieve the generated file.
GenerateReportAndEmail
Generates a report and emails it as an attachment.
GetAllReportObjectNames
Returns all the query/report database object names.
GetAvailableReportObjectNames
Returns the query/report database object names that are available to non administrator users.
GetDefaultReportParams
Returns an array of default report parameters for the specified group or subnet.
GetReport
Returns a report object.
GetStoredProcedureParameters
Returns the parameters of a database stored procedure.
GetTableFieldInfo
Returns the fields that belong to a database table.
GetViewFieldInfo
Returns the fields that belong to a database view.

Method ExecuteQuery

Executes a database query and returns the results in a binary format. Only SELECT queries are allowed.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In QuerySQL Widestring
The SQL query string.
In Parameters TParamList
The query parmeters.
In RunAsAdministrator Boolean
When true, the query will be run in administrator mode. This allows access to all tables in the database and can only be executed by an Administrator or Super Administrator.

Return Value:

Flag Name Type
Result Result Binary

Oxygene Syntax:

method EasyIPReport.ExecuteQuery(const OperationID: WideString ; const QuerySQL: Widestring ; const Parameters: TParamList ; const RunAsAdministrator: Boolean) : Binary;

C# Syntax:

public Binary EasyIPReport.ExecuteQuery(WideString OperationID , String QuerySQL , TParamList Parameters , Boolean RunAsAdministrator);

Delphi Syntax:

function EasyIPReport.ExecuteQuery(const OperationID: WideString ; const QuerySQL: Widestring ; const Parameters: TParamList ; const RunAsAdministrator: Boolean) : Binary;

Method ExecuteQuery2

Executes a database query and returns the results as simple data. Only SELECT queries are allowed.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In QuerySQL WideString
The SQL query string.
In Parameters TParamList
The query parameters.
In RunAsAdministrator Boolean
When true, the query will be run in administrator mode. This allows access to all tables in the database and can only be executed by an Administrator or Super Administrator.

Return Value:

Flag Name Type
Result Result TSimpleData

Oxygene Syntax:

method EasyIPReport.ExecuteQuery2(const OperationID: WideString ; const QuerySQL: WideString ; const Parameters: TParamList ; const RunAsAdministrator: Boolean) : TSimpleData;

C# Syntax:

public TSimpleData EasyIPReport.ExecuteQuery2(WideString OperationID , WideString QuerySQL , TParamList Parameters , Boolean RunAsAdministrator);

Delphi Syntax:

function EasyIPReport.ExecuteQuery2(const OperationID: WideString ; const QuerySQL: WideString ; const Parameters: TParamList ; const RunAsAdministrator: Boolean) : TSimpleData;

Method ExportQuery

Exports a query to the specified format.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ReportFilename WideString
The virtual filename of the report that you want to run.
In Parameters TParamList
The query parameters.
In QueryExportType TQueryExportType
The format that you want to use for the exported data.
In ExportParamNames TStringArray
Additional parameters for the export. These parameters vary depending on the QueryExportType.
In ExportParamValues TStringArray
Additional parameter values for the export. These parameter values vary depending on the QueryExportType.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPReport.ExportQuery(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const QueryExportType: TQueryExportType ; const ExportParamNames: TStringArray ; const ExportParamValues: TStringArray) : WideString;

C# Syntax:

public WideString EasyIPReport.ExportQuery(WideString OperationID , WideString ReportFilename , TParamList Parameters , TQueryExportType QueryExportType , TStringArray ExportParamNames , TStringArray ExportParamValues);

Delphi Syntax:

function EasyIPReport.ExportQuery(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const QueryExportType: TQueryExportType ; const ExportParamNames: TStringArray ; const ExportParamValues: TStringArray) : WideString;

Method ExportQueryAndEmail

Exports a query, then emails it to the specified recipient.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ReportFilename WideString
The virtual filename of the report that you want to run.
In Parameters TParamList
The query parameters.
In QueryExportType TQueryExportType
The format that you want to use for the exported data.
In Recipients WideString
The recipients of the email.
In Subject WideString
The subject of the email.
In EmailFilename WideString
The filename to be used for the email attachment.
In ExportParamNames TStringArray
Additional parameters for the export. These parameters vary depending on the QueryExportType.
In ExportParamValues TStringArray
Additional parameter values for the export. These parameter values vary depending on the QueryExportType.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPReport.ExportQueryAndEmail(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const QueryExportType: TQueryExportType ; const Recipients: WideString ; const Subject: WideString ; const EmailFilename: WideString ; const ExportParamNames: TStringArray ; const ExportParamValues: TStringArray) : Boolean;

C# Syntax:

public Boolean EasyIPReport.ExportQueryAndEmail(WideString OperationID , WideString ReportFilename , TParamList Parameters , TQueryExportType QueryExportType , WideString Recipients , WideString Subject , WideString EmailFilename , TStringArray ExportParamNames , TStringArray ExportParamValues);

Delphi Syntax:

function EasyIPReport.ExportQueryAndEmail(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const QueryExportType: TQueryExportType ; const Recipients: WideString ; const Subject: WideString ; const EmailFilename: WideString ; const ExportParamNames: TStringArray ; const ExportParamValues: TStringArray) : Boolean;

Method GenerateReport

Generates a report. A GUID string is returned. Pass the GUID to the GetDownloadFileSize and GetDownloadFilePart methods (EasyIPService) to retrieve the generated file.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ReportFilename WideString
The virtual filename of the report that you want to run.
In Parameters TParamList
The report query parameters.
In Viewname WideString
The name of the report view you want to use.
In ExportFormat WideString
The format that you want to use for the report.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPReport.GenerateReport(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const Viewname: WideString ; const ExportFormat: WideString) : WideString;

C# Syntax:

public WideString EasyIPReport.GenerateReport(WideString OperationID , WideString ReportFilename , TParamList Parameters , WideString Viewname , WideString ExportFormat);

Delphi Syntax:

function EasyIPReport.GenerateReport(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const Viewname: WideString ; const ExportFormat: WideString) : WideString;

Method GenerateReportAndEmail

Generates a report and emails it as an attachment.

Parameters:

Flag Name Type Description
In OperationID WideString
The operation ID is a unique string value that can be used to cancel the operation from the client. The string can be anything you like, but a GUID is recommended.
In ReportFilename WideString

In Parameters TParamList
The report query parameters.
In Viewname WideString
The name of the report view you want to use.
In ExportFormat WideString
The format that you want to use for the report.
In Recipients WideString
The email recipients
In Subject WideString
The email subject
In EmailFilename WideString
The filename for the email attachment.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPReport.GenerateReportAndEmail(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const Viewname: WideString ; const ExportFormat: WideString ; const Recipients: WideString ; const Subject: WideString ; const EmailFilename: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPReport.GenerateReportAndEmail(WideString OperationID , WideString ReportFilename , TParamList Parameters , WideString Viewname , WideString ExportFormat , WideString Recipients , WideString Subject , WideString EmailFilename);

Delphi Syntax:

function EasyIPReport.GenerateReportAndEmail(const OperationID: WideString ; const ReportFilename: WideString ; const Parameters: TParamList ; const Viewname: WideString ; const ExportFormat: WideString ; const Recipients: WideString ; const Subject: WideString ; const EmailFilename: WideString) : Boolean;

Method GetAllReportObjectNames

Returns all the query/report database object names.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TReportObjects

Oxygene Syntax:

method EasyIPReport.GetAllReportObjectNames() : TReportObjects;

C# Syntax:

public TReportObjects EasyIPReport.GetAllReportObjectNames();

Delphi Syntax:

function EasyIPReport.GetAllReportObjectNames() : TReportObjects;

Method GetAvailableReportObjectNames

Returns the query/report database object names that are available to non administrator users.

Parameters:

None.

Return Value:

Flag Name Type
Result Result TReportObjects

Oxygene Syntax:

method EasyIPReport.GetAvailableReportObjectNames() : TReportObjects;

C# Syntax:

public TReportObjects EasyIPReport.GetAvailableReportObjectNames();

Delphi Syntax:

function EasyIPReport.GetAvailableReportObjectNames() : TReportObjects;

Method GetDefaultReportParams

Returns an array of default report parameters for the specified group or subnet.

Parameters:

Flag Name Type Description
In ReportFilename WideString
The virtual filename of the report.
In AutonomousNetworkId Int64
The ID of the autonomous network.
In SubnetId Int64
The ID of the subnet.

Return Value:

Flag Name Type
Result Result TParamList

Oxygene Syntax:

method EasyIPReport.GetDefaultReportParams(const ReportFilename: WideString ; const AutonomousNetworkId: Int64 ; const SubnetId: Int64) : TParamList;

C# Syntax:

public TParamList EasyIPReport.GetDefaultReportParams(WideString ReportFilename , Int64 AutonomousNetworkId , Int64 SubnetId);

Delphi Syntax:

function EasyIPReport.GetDefaultReportParams(const ReportFilename: WideString ; const AutonomousNetworkId: Int64 ; const SubnetId: Int64) : TParamList;

Method GetReport

Returns a report object.

Parameters:

Flag Name Type Description
In ReportFilename WideString
The virtual filename of the report.

Return Value:

Flag Name Type
Result Result TEasyIPQueryReport

Oxygene Syntax:

method EasyIPReport.GetReport(const ReportFilename: WideString) : TEasyIPQueryReport;

C# Syntax:

public TEasyIPQueryReport EasyIPReport.GetReport(WideString ReportFilename);

Delphi Syntax:

function EasyIPReport.GetReport(const ReportFilename: WideString) : TEasyIPQueryReport;

Method GetStoredProcedureParameters

Returns the parameters of a database stored procedure.

Parameters:

Flag Name Type Description
In StoredProcedureName WideString
The name of the stored procedure.

Return Value:

Flag Name Type
Result Result TFieldInfos

Oxygene Syntax:

method EasyIPReport.GetStoredProcedureParameters(const StoredProcedureName: WideString) : TFieldInfos;

C# Syntax:

public TFieldInfos EasyIPReport.GetStoredProcedureParameters(WideString StoredProcedureName);

Delphi Syntax:

function EasyIPReport.GetStoredProcedureParameters(const StoredProcedureName: WideString) : TFieldInfos;

Method GetTableFieldInfo

Returns the fields that belong to a database table.

Parameters:

Flag Name Type Description
In Tablename WideString
The name of the table.

Return Value:

Flag Name Type
Result Result TFieldInfos

Oxygene Syntax:

method EasyIPReport.GetTableFieldInfo(const Tablename: WideString) : TFieldInfos;

C# Syntax:

public TFieldInfos EasyIPReport.GetTableFieldInfo(WideString Tablename);

Delphi Syntax:

function EasyIPReport.GetTableFieldInfo(const Tablename: WideString) : TFieldInfos;

Method GetViewFieldInfo

Returns the fields that belong to a database view.

Parameters:

Flag Name Type Description
In Viewname WideString
The name of the view.

Return Value:

Flag Name Type
Result Result TFieldInfos

Oxygene Syntax:

method EasyIPReport.GetViewFieldInfo(const Viewname: WideString) : TFieldInfos;

C# Syntax:

public TFieldInfos EasyIPReport.GetViewFieldInfo(WideString Viewname);

Delphi Syntax:

function EasyIPReport.GetViewFieldInfo(const Viewname: WideString) : TFieldInfos;
Service EasyIPUtils

The following table lists the Operations defined in "EasyIPUtils":

CheckMultipleIPVersions
Checks that all the IP addresses in an array are of a specific type.
GetBroadcastAddress
Returns the broadcast address of a subnet.
GetHighAddress
Returns the high address of a subnet.
GetIPAddressList
Returns all the IP addresses available in a specific subnet.
GetIPVers
Returns the IP version of a string.
GetLowAddress
Returns the low address of a subnet.
GetSubnet
Returns the subnet portion of an IP address.
IsIPLowerThan
Returns true if IP1 is less than IP2.
PadIPAddress
Pads an IPv4 or IPv6 address with zeros.
UnPadIPAddress
Removes leading zeros from an IP address. In the case of IPv6 addresses, the IP address will be shortened to it's most compact form e.g. FFFF:0000:0000:0000:0001:000D:0211:1111 will become FFFF::1:D:211:1111.
GetMaskListValues
Returns all the subnet masks in a range.
GetSubnetRange
Returns a list of child subnets given a parent subnet and child subnet mask.
GetSubnetInfoHTML
Returns information about a subnet in HTML format.
GetIPInfo
Returns information about an IP address.

Method CheckMultipleIPVersions

Checks that all the IP addresses in an array are of a specific type.

Parameters:

Flag Name Type Description
In IPAddresses TStringArray
The array of IP address that you want to check.
In IPVersion TIPVers
The IP version that all the IP addresses are required to be.

Return Value:

None.

Oxygene Syntax:

method EasyIPUtils.CheckMultipleIPVersions(const IPAddresses: TStringArray ; const IPVersion: TIPVers);

C# Syntax:

public void EasyIPUtils.CheckMultipleIPVersions(TStringArray IPAddresses , TIPVers IPVersion);

Delphi Syntax:

procedure EasyIPUtils.CheckMultipleIPVersions(const IPAddresses: TStringArray ; const IPVersion: TIPVers) ;

Method GetBroadcastAddress

Returns the broadcast address of a subnet.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.GetBroadcastAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

C# Syntax:

public WideString EasyIPUtils.GetBroadcastAddress(WideString Subnet , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetBroadcastAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

Method GetHighAddress

Returns the high address of a subnet.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.GetHighAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

C# Syntax:

public WideString EasyIPUtils.GetHighAddress(WideString Subnet , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetHighAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

Method GetIPAddressList

Returns all the IP addresses available in a specific subnet.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPUtils.GetIPAddressList(const Subnet: WideString ; const CidrMask: Integer) : TStringArray;

C# Syntax:

public TStringArray EasyIPUtils.GetIPAddressList(WideString Subnet , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetIPAddressList(const Subnet: WideString ; const CidrMask: Integer) : TStringArray;

Method GetIPVers

Returns the IP version of a string.

Parameters:

Flag Name Type Description
In IP WideString
The IP text.

Return Value:

Flag Name Type
Result Result TIPVers

Oxygene Syntax:

method EasyIPUtils.GetIPVers(const IP: WideString) : TIPVers;

C# Syntax:

public TIPVers EasyIPUtils.GetIPVers(WideString IP);

Delphi Syntax:

function EasyIPUtils.GetIPVers(const IP: WideString) : TIPVers;

Method GetLowAddress

Returns the low address of a subnet.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.GetLowAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

C# Syntax:

public WideString EasyIPUtils.GetLowAddress(WideString Subnet , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetLowAddress(const Subnet: WideString ; const CidrMask: Integer) : WideString;

Method GetSubnet

Returns the subnet portion of an IP address.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.GetSubnet(const Subnet: WideString ; const CidrMask: Integer) : WideString;

C# Syntax:

public WideString EasyIPUtils.GetSubnet(WideString Subnet , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetSubnet(const Subnet: WideString ; const CidrMask: Integer) : WideString;

Method IsIPLowerThan

Returns true if IP1 is less than IP2.

Parameters:

Flag Name Type Description
In IP1 WideString
IP address 1.
In IP2 WideString
IP address 2.

Return Value:

Flag Name Type
Result Result Boolean

Oxygene Syntax:

method EasyIPUtils.IsIPLowerThan(const IP1: WideString ; const IP2: WideString) : Boolean;

C# Syntax:

public Boolean EasyIPUtils.IsIPLowerThan(WideString IP1 , WideString IP2);

Delphi Syntax:

function EasyIPUtils.IsIPLowerThan(const IP1: WideString ; const IP2: WideString) : Boolean;

Method PadIPAddress

Pads an IPv4 or IPv6 address with zeros.

Parameters:

Flag Name Type Description
In IP WideString
The IP address.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.PadIPAddress(const IP: WideString) : WideString;

C# Syntax:

public WideString EasyIPUtils.PadIPAddress(WideString IP);

Delphi Syntax:

function EasyIPUtils.PadIPAddress(const IP: WideString) : WideString;

Method UnPadIPAddress

Removes leading zeros from an IP address. In the case of IPv6 addresses, the IP address will be shortened to it's most compact form e.g. FFFF:0000:0000:0000:0001:000D:0211:1111 will become FFFF::1:D:211:1111.

Parameters:

Flag Name Type Description
In IP WideString
The IP address.

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.UnPadIPAddress(const IP: WideString) : WideString;

C# Syntax:

public WideString EasyIPUtils.UnPadIPAddress(WideString IP);

Delphi Syntax:

function EasyIPUtils.UnPadIPAddress(const IP: WideString) : WideString;

Method GetMaskListValues

Returns all the subnet masks in a range.

Parameters:

Flag Name Type Description
In LowMask Integer
The low mask.
In HighMask Integer
The high mask.
In IPVers TIPVers
The IP version of the masks.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPUtils.GetMaskListValues(const LowMask: Integer ; const HighMask: Integer ; const IPVers: TIPVers) : TStringArray;

C# Syntax:

public TStringArray EasyIPUtils.GetMaskListValues( Int32 LowMask , Int32 HighMask , TIPVers IPVers);

Delphi Syntax:

function EasyIPUtils.GetMaskListValues(const LowMask: Integer ; const HighMask: Integer ; const IPVers: TIPVers) : TStringArray;

Method GetSubnetRange

Returns a list of child subnets given a parent subnet and child subnet mask.

Parameters:

Flag Name Type Description
In Subnet WideString
The parent subnet.
In ParentMask Integer
The parent cidr mask.
In CidrMask Integer
The cidr mask of the child subnets.

Return Value:

Flag Name Type
Result Result TStringArray

Oxygene Syntax:

method EasyIPUtils.GetSubnetRange(const Subnet: WideString ; const ParentMask: Integer ; const CidrMask: Integer) : TStringArray;

C# Syntax:

public TStringArray EasyIPUtils.GetSubnetRange(WideString Subnet , Int32 ParentMask , Int32 CidrMask);

Delphi Syntax:

function EasyIPUtils.GetSubnetRange(const Subnet: WideString ; const ParentMask: Integer ; const CidrMask: Integer) : TStringArray;

Method GetSubnetInfoHTML

Returns information about a subnet in HTML format.

Parameters:

Flag Name Type Description
In Subnet WideString
The subnet.
In CidrMask Integer
The cidr mask of the subnet.
In ChildMask Integer
The cidr mask of the child subnets (0 if there are no child subnets).

Return Value:

Flag Name Type
Result Result WideString

Oxygene Syntax:

method EasyIPUtils.GetSubnetInfoHTML(const Subnet: WideString ; const CidrMask: Integer ; const ChildMask: Integer) : WideString;

C# Syntax:

public WideString EasyIPUtils.GetSubnetInfoHTML(WideString Subnet , Int32 CidrMask , Int32 ChildMask);

Delphi Syntax:

function EasyIPUtils.GetSubnetInfoHTML(const Subnet: WideString ; const CidrMask: Integer ; const ChildMask: Integer) : WideString;

Method GetIPInfo

Returns information about an IP address.

Parameters:

Flag Name Type Description
In IPAddress WideString
The IP address.
In CidrMask Integer
The cidr mask of the IP address.
Out IPVersion TIPVers
Returns the IP version.
Out Subnet WideString
Returns the subnet.
Out LowAddress WideString
Returns the low address of the IP's subnet.
Out HighAddress WideString
Returns the high address of the IP's subnet.
Out BroadcastAddress WideString
Returns the broadcast address of the IP's subnet.
Out MaxSubnetMask Integer
Returns the maximum subnet mask.

Return Value:

None.

Oxygene Syntax:

method EasyIPUtils.GetIPInfo(const IPAddress: WideString ; const CidrMask: Integer ; IPVersion: TIPVers ; Subnet: WideString ; LowAddress: WideString ; HighAddress: WideString ; BroadcastAddress: WideString ; MaxSubnetMask: Integer);

C# Syntax:

public void EasyIPUtils.GetIPInfo(WideString IPAddress , Int32 CidrMask , out TIPVers IPVersion , out WideString Subnet , out WideString LowAddress , out WideString HighAddress , out WideString BroadcastAddress , out Int32 MaxSubnetMask);

Delphi Syntax:

procedure EasyIPUtils.GetIPInfo(const IPAddress: WideString ; const CidrMask: Integer ; IPVersion: TIPVers ; Subnet: WideString ; LowAddress: WideString ; HighAddress: WideString ; BroadcastAddress: WideString ; MaxSubnetMask: Integer) ;
Event Sinks

The following table lists the Event Sinks defined in "EasyIPLibrary":

EasyIPEvents
The EasyIPEvents event is sent to clients to inform them about the progress of an operation.
Event Sink EasyIPEvents

The following table lists the Events defined in "EasyIPEvents":

OnServerEvent
An array of parameter names.

Event OnServerEvent


Parameters:

Flag Name Type Description
In EventType TEventType
The type of event that occurred.
In ParameterNames TStringArray
A list of parameter names
In ParameterValues VariantArray
An array of parameter values

Return Value:

None.

Oxygene Syntax:

method EasyIPEvents.OnServerEvent(const EventType: TEventType ; const ParameterNames: TStringArray ; const ParameterValues: VariantArray);

C# Syntax:

public void EasyIPEvents.OnServerEvent(TEventType EventType , TStringArray ParameterNames , VariantArray ParameterValues);

Delphi Syntax:

procedure EasyIPEvents.OnServerEvent(const EventType: TEventType ; const ParameterNames: TStringArray ; const ParameterValues: VariantArray) ;
Structs

The following table lists the Structs defined in "EasyIPLibrary":

TVirtualFile

TVirtualDirectory

TSubnet

TUserTable

TUserPrivilegeRight

TUserPrivilege

TSystemSettings

TEditResult

TUserField

TUserFieldLookup

TFieldPendingUpdate

TFieldDataTypeInfo

TUserFieldDisplayOrder

TEasyIPDeltaChangeValue

TEasyIPDelta

TTableScript

TUserInfoMessage

TDefaultValue

TUserTableExtendedAttributes

TServerSettings

TEventSchedule

TClientSettings

TTemplateParameter

TTemplateScript

TMissingSubnet

TSubnetId

TDiscoveryData

TDiscoveryIPAddressValue

TDiscoveryIPAddressData

TDiscoveryResult

TDiscoverableSubnet(TSubnetId)

TAuthenticationDetail

TLoginInfo

TParamItem

TReportObjects

TFieldInfo

TEasyIPReportView

TEasyIPQuery

TQuerySQL

TEasyIPQueryReport

TSimpleReport

TCatcheableError

TDiscoveryIPAddressPingValues

TFileInfo

TUserSession

TEmailQueueItem

TWebClientSettings

TFavourite

TExternalTool

TDiscoveryARPValue

TChangeLogEntry

TDiscoveryUpdateResult

TPingHistory

TPingHistoryResult

TDiscoveryBot

TQueuedDiscovery

TDiscoveryBotSettings

TChangeLogItem

TParameterValue

TUserInformation
    FUserInfo.Id := ResultDataSet.FieldByName('ID').AsLargeInt;
    FUserInfo.Username := ResultDataSet.FieldByName('USER_NAME').AsString;
    FUserInfo.Name := ResultDataSet.FieldByName('NAME').AsString;
    FUserInfo.UserType := IntegerToUserType(ResultDataSet.FieldByName('USER_TYPE').AsLargeInt);
    FUserInfo.AuthenticationType := ResultDataSet.FieldByName('AUTHENTICATION_TYPE').AsString;
    FUserInfo.GroupId := ResultDataSet.FieldByName('GROUP_ID').AsLargeInt;
    FUserInfo.Email := ResultDataSet.FieldByName('EMAIL').AsString;
    FUserInfo.Created := ResultDataSet.FieldByName('CREATED').AsDateTime;
    FUserInfo.LastLogin := ResultDataSet.FieldByName('LAST_LOGIN').AsDateTime;
    FUserInfo.UserDirectory := GetUserDirectory(FUserInfo.Username);
TLinkedIPAddress

TLinkedIPAddressDescription

TEasyIPDeltaChange

TSimpleData

TSimpleDataField

TEasyIPUser(TBaseEasyIPUser)

TBaseEasyIPUser

TEasyIPUserGroup(TBaseEasyIPUser)

TUndoItem

TTemplateScript2(TTemplateScript)

TGlobalNetToolSettings

TThinfinitySettings

Struct TVirtualFile

The following table lists the fields defined in "TVirtualFile":

Field Data Type Documentation
Id Int64

DirectoryId Int64

Directory Widestring

Filename Widestring

FileType Widestring

FilePath Widestring

FileSize Integer

FileData Binary

FileDataLinkId Int64

ReadOnly Boolean

Created DateTime

Modified DateTime

Struct TVirtualDirectory

The following table lists the fields defined in "TVirtualDirectory":

Field Data Type Documentation
Id Int64

ParentId Int64

Directory Widestring

ChildCount Integer

SystemDirectory Boolean

Created DateTime

Modified DateTime

Struct TSubnet

The following table lists the fields defined in "TSubnet":

Field Data Type Documentation
AutonomousNetworkId Int64

SubnetId Int64

Subnet Widestring

CidrMask Integer

Comment WideString

AutonomousNetworkName WideString

Struct TUserTable

The following table lists the fields defined in "TUserTable":

Field Data Type Documentation
TableId Int64

ParentTableId Int64

TableName Widestring

LogicalTableName Widestring

PrimaryKeyName Widestring

HiddenFromUser Boolean

ExtendedAttributes TUserTableExtendedAttributes

Struct TUserPrivilegeRight

The following table lists the fields defined in "TUserPrivilegeRight":

Field Data Type Documentation
Id Int64

UserPrivsId Int64

TableId Int64

TableName Widestring

CanSelect Boolean

CanInsert Boolean

CanUpdate Boolean

CanDelete Boolean

Struct TUserPrivilege

The following table lists the fields defined in "TUserPrivilege":

Field Data Type Documentation
Id Int64

UserId Int64

Root Boolean

AutonomousNetworkId Int64

SubnetId Int64

SubnetPath Widestring

UserPrivilegeRights TUserPrivilegeRights

Struct TSystemSettings

The following table lists the fields defined in "TSystemSettings":

Field Data Type Documentation
MaxSubnets Int64

MaxIPAddresses Int64

ResellerName WideString

ResellerSalesEmail WideString

ResellerSupportEmail WideString

ResellerWeb WideString

ResellerBugWeb WideString

ResellerPhone WideString

ResellerAddress WideString

CacheVirtualFiles Boolean

Struct TEditResult

The following table lists the fields defined in "TEditResult":

Field Data Type Documentation
Cancelled Boolean

AutonomousNetworkId Int64

TotalSubnetCount Int64

TotalIPAddressesCount Int64

AddedSubnetCount Int64

AddedIPAddressCount Int64

AddedIPAddressList TStringArray

DeletedSubnetCount Int64

DeletedIPAddressCount Int64

UndoDescription Widestring

NoMoreUndos Boolean

Error Boolean

ErrorDescription Widestring

UserMessage Widestring

UserMessageTitle Widestring

UserMessageDetails Widestring

SelectedSubnetIds TInt64Array

RefreshSubnetIds TInt64Array

Struct TUserField

The following table lists the fields defined in "TUserField":

Field Data Type Documentation
TableId Int64

FieldId Int64

TableName Widestring

FieldName Widestring

DisplayName Widestring

LookupType TUserFieldLookupType

LookupList TUserFieldLookups

SystemField Boolean

ReadOnly Boolean

Selectable Boolean

ReadOnlyProperties Boolean

StoreRevisions Boolean

HiddenInAdmin Boolean

HiddenColumn Boolean

FixedColumn Boolean

DoNotExport Boolean

DisplayAsURL Boolean

UnavailableForDiscoveries Boolean

Mandatory Boolean

BackgroundColour Variant

FontColour Variant

FontBold Boolean

FontItalic Boolean

FontUnderline Boolean

ColumnIndex Integer

DefaultColumnWidth Integer

DefaultValue Widestring

EditMask Widestring

FieldSize Integer

FieldType TEIPDataType

FieldTypeDescription Widestring

Indexed TFieldIndexType

FieldDelimiters Widestring

Weight Integer

Struct TUserFieldLookup

The following table lists the fields defined in "TUserFieldLookup":

Field Data Type Documentation
Index Integer

Caption Widestring

Description Widestring

BackgroundColour Variant

FontColour Variant

FontBold Boolean

FontItalic Boolean

FontUnderline Boolean

Struct TFieldPendingUpdate

The following table lists the fields defined in "TFieldPendingUpdate":

Field Data Type Documentation
FieldName Widestring

TableId Integer

TableName Widestring

FieldUpdateAction TFieldUpdateAction

FieldType TEIPDataType

FieldSize Integer

Status TFieldUpdateStatus

Struct TFieldDataTypeInfo

The following table lists the fields defined in "TFieldDataTypeInfo":

Field Data Type Documentation
DataType TEIPDataType

Description Widestring

Struct TUserFieldDisplayOrder

The following table lists the fields defined in "TUserFieldDisplayOrder":

Field Data Type Documentation
FieldId Integer

FieldIndex Integer

Struct TEasyIPDeltaChangeValue

The following table lists the fields defined in "TEasyIPDeltaChangeValue":

Field Data Type Documentation
FieldName Widestring

OldValue Variant

NewValue Variant

ReadOnly Boolean

Struct TEasyIPDelta

The following table lists the fields defined in "TEasyIPDelta":

Field Data Type Documentation
SubnetID Int64

TableName Widestring

DeltaChanges TEasyIPDeltaChanges

Struct TTableScript

The following table lists the fields defined in "TTableScript":

Field Data Type Documentation
TableName Widestring

InsertScript Widestring

UpdateScript Widestring

DeleteScript Widestring

InsertScriptEnabled Boolean

UpdateScriptEnabled Boolean

DeleteScriptEnabled Boolean

Struct TUserInfoMessage

The following table lists the fields defined in "TUserInfoMessage":

Field Data Type Documentation
UserMessageText Widestring

UserMessageLink WideString

Created DateTime

UserMessageType TUserMessageType

Username Widestring

Struct TDefaultValue

The following table lists the fields defined in "TDefaultValue":

Field Data Type Documentation
FieldName Widestring

DefaultValue Variant

Struct TUserTableExtendedAttributes

The following table lists the fields defined in "TUserTableExtendedAttributes":

Field Data Type Documentation
Scripts TTableScript

DefaultValues TDefaultValues

MandatoryFields TStringArray

UserFields TUserFields

Tag Integer

Struct TServerSettings

The following table lists the fields defined in "TServerSettings":

Field Data Type Documentation
Accounts_MinimumPasswordLength Integer

DB_DatabaseServerType TServerType

DB_FirebirdServerDatabase WideString

DB_FirebirdServerPort Integer

DB_FirebirdServerServer Widestring

DB_FirebirdServerSYSDBAPassword Widestring

DB_FirebirdServerSYSDBAUsername Widestring

DB_FirebirdCharacterSet WideString

DB_FirebirdEmbeddedDatabase WideString

DB_FirebirdEmbeddedCharacterSet WideString

DB_DemoDatabase WideString

SubnetInheritance_Enabled Boolean

SubnetInheritance_Fields TStringArray

Edit_MaximumMissingSubnets Integer

Edit_LockRecords Boolean

Email_From Widestring

Email_PasswordRequestBody Widestring

Email_PasswordRequestSubject Widestring

Email_SMTPPassword Widestring

Email_SMTPServer Widestring

Email_SMTPPort Integer

Email_SMTPUsername Widestring

Email_SMTPRequiresAuthentication Boolean

Email_SMTPRequiresSSL Boolean

Email_QueuePurgeDays Integer

Email_QueueCheckInterval Integer

Email_UsernameRequestBody Widestring

Email_UsernameRequestSubject WideString

Email_PasswordResetBody Widestring

Email_PasswordResetSubject Widestring

Email_NewUserBody WideString

Email_NewUserSubject WideString

Email_ServerRetryMinutes Integer

Logs_Directory Widestring

Logs_DirectoryPerDay Boolean

Logs_FileLogLevel TLogLevel

Logs_ControllerLogLevel TLogLevel

Logs_DebugIgnoreMethods TStringArray

Logs_LogRawBinPacketData Boolean

Logs_LogRawSOAPPacketData Boolean

Security_SSLCertificateFile Widestring

Security_SSLKeyFile Widestring

Security_SSLPassPhrase Widestring

Security_SSLRootCertificateFile Widestring

Security_SSLVerificationDepth Integer

Security_UseSSL Boolean

Server_CompressData Boolean

Server_InactivityTimeout Integer

Server_SessionTimeout Integer

Server_EncryptData Boolean

Server_SendEncryptionKey WideString

Server_ReceiveEncryptionKey WideString

Server_EncryptionType TEncryptionType

Server_EncryptionPassword WideString

Server_Port Integer

Server_SSLPort Integer

Server_RemoteEventFrequency Integer

Server_ClientRequestTimeout Integer

Server_MaxQueue Integer

Server_PoolThreads Integer

Server_MaxThreads Integer

Server_ReservedLicencesCustom Integer

VirtualFiles_AllowAdminsToDeleteNonEmptyDirectories Boolean

VirtualFiles_AllowUsersToDeleteNonEmptyDirectories Boolean

VirtualFiles_CompressFiles Boolean

VirtualFiles_DefaultUserDirectory Widestring

VirtualFiles_MaximumVirtualFileSize Integer

VirtualFiles_CacheVirtualFilesOnClients Boolean

Search_MaxResults Integer

Search_MinTokenLength Integer

Search_MaxTokenLength Integer

BasicSearch_Enabled Boolean

FTS_Enabled Boolean

FTS_FieldDelimiters Widestring

FTS_StopPhrases TStringArray

FTS_UpdateTimestamp DateTime

FTS_IndexingEnabled Boolean

Reports_AvailableObjects TReportObjects

PingLogging_Enabled Boolean

PingLogging_EnableForAllUsers Boolean

PingLogging_UserIds TInt64Array

Backup_FrequencyType TScheduleEventFrequencyType

Backup_Time DateTime

Backup_Directory WideString

Backup_TestRestore Boolean

Backup_PurgeBackups Boolean

Backup_PurgeDays Integer

Backup_RestoreDirectory WideString

Backup_PageSize Integer

Backup_PurgeChangeLogs Boolean

Backup_PurgeChangeLogsDays Integer

Backup_PurgePingLogs Boolean

Backup_PurgePingLogsDays Integer

Backup_RecalculateDatabaseSelectivity Boolean

Backup_EmailResults Boolean

Backup_EmailRecipients WideString

Backup_EmailIncludeLog Boolean

ChangeLogging_LogStructuralChanges Boolean

ChangeLogging_DetailedChangeLogs Boolean

ChangeLogging_LogFieldRevisions Boolean

ChangeLogging_LogFieldRevisionsWhenImporting Boolean

UserFiles_Directory WideString

ClientUpdates_AllowLaterClientsToUpgrade Boolean

ClientUpdates_UpgradeType TClientUpgradeType

UserRestrictions_MinAdminLevelCreateAN TUserType

DiscoveryBots_QueueCheckFrequency Integer

SOAPServer_Enabled Boolean

SOAPServer_Port Integer

SOAPServer_SSLPort Integer

SOAPServer_WriteMultiRefArray Boolean

SOAPServer_WriteMultiRefObject Boolean

SOAPServer_SendUntyped Boolean

SOAPServer_StrictStructureFieldOrder Boolean

SOAPServer_EncodedXML Boolean

SOAPServer_ClientIDInWSDL Boolean

SOAPServer_Document Boolean

SOAPServer_ExternalTypesAsReferences Boolean

SOAPServer_SOAP12 Boolean

SOAPServer_SOAPMode TSOAPMode

Struct TEventSchedule

The following table lists the fields defined in "TEventSchedule":

Field Data Type Documentation
ScheduleType TScheduleEventFrequencyType

UserId AnsiString

Created AnsiString

NextRun DateTime

EventType TScheduledEventType

RemoveEventAfterLastRun Boolean

FirstExecutionDateTime DateTime

LastExecutionDateTime DateTime

Command Widestring

TimeInterval DateTime

TimeDay DateTime

DailyDaysBetween Integer

WeeksBetween Integer

WeeklyMonday Boolean

WeeklyTuesday Boolean

WeeklyWednesday Boolean

WeeklyThursday Boolean

WeeklyFriday Boolean

WeeklySaturday Boolean

WeeklySunday Boolean

MonthlyDayOfMonth Boolean

MonthlyJanuary Boolean

MonthlyFebruary Boolean

MonthlyMarch Boolean

MonthlyApril Boolean

MonthlyMay Boolean

MonthlyJune Boolean

MonthlyJuly Boolean

MonthlyAugust Boolean

MonthlySpetember Boolean

MonthlyOctober Boolean

MonthlyNovember Boolean

MonthlyDecember Boolean

Struct TClientSettings
Struct TTemplateParameter

The following table lists the fields defined in "TTemplateParameter":

Field Data Type Documentation
Name Widestring

DisplayName Widestring

TableName Widestring

FieldName Widestring

Description Widestring

TemplateParameterType TTemplateParamType

Required Boolean

ReadOnly Boolean

Category Widestring

MaxLength Integer

Value Variant

RemoveLineIfEmpty Boolean

LookupItems TStringArray

OnlyLookupListItems Boolean

SkipRecordIfEmpty Boolean

DatePartFormat Widestring

RemoveLeadingZeros Boolean

LowInteger Integer

HighInteger Integer

Struct TTemplateScript

The following table lists the fields defined in "TTemplateScript":

Field Data Type Documentation
Name Widestring

Script Widestring

Header Widestring

Footer Widestring

Body Widestring

Parameters TTemplateParameters

TemplateType TTemplateType

HeaderFooterForEachSubnet Boolean

Struct TMissingSubnet

The following table lists the fields defined in "TMissingSubnet":

Field Data Type Documentation
Subnet Widestring

CidrMask Integer

Comment Widestring

AddressCount Int64

ExistingSubnet Boolean

Struct TSubnetId

The following table lists the fields defined in "TSubnetId":

Field Data Type Documentation
AutonomousNetworkId Int64

SubnetId Int64

Struct TDiscoveryData

The following table lists the fields defined in "TDiscoveryData":

Field Data Type Documentation
AutnomousNetworkId Int64

SubnetId Int64

Subnet Widestring

CidrMask Integer

IPAddressData TDiscoveryIPAddressDataList

Error Widestring

FinishedSubnet Boolean

TotalIPAddressDataRecords Integer

CompletedCount Integer

SubnetIndex Integer

Struct TDiscoveryIPAddressValue

The following table lists the fields defined in "TDiscoveryIPAddressValue":

Field Data Type Documentation
FieldName Widestring

FieldValue Variant

OriginalFieldValue Variant

Updated Boolean

Struct TDiscoveryIPAddressData

The following table lists the fields defined in "TDiscoveryIPAddressData":

Field Data Type Documentation
IPAddressId Int64

IPAddress Widestring

Values TDiscoveryIPAddressValues

PingValues TDiscoveryIPAddressPingValues

ARPValues TDiscoveryARPValues

Struct TDiscoveryResult

The following table lists the fields defined in "TDiscoveryResult":

Field Data Type Documentation
SubnetId Int64

IPAddressData TDiscoveryIPAddressDataList

Struct TDiscoverableSubnet

The following table lists the fields defined in "TDiscoverableSubnet":

Field Data Type Documentation
Subnet Widestring

CidrMask Integer

TotalIPAddressCount Integer

Struct TAuthenticationDetail

The following table lists the fields defined in "TAuthenticationDetail":

Field Data Type Documentation
Id Widestring

Name Widestring

Description Widestring

Author Widestring

Struct TLoginInfo

The following table lists the fields defined in "TLoginInfo":

Field Data Type Documentation
UserId Int64

SessionId Widestring

ServerVersion Integer

UnicodeDatabase Boolean

InactivityTimeout Integer

UserMessage WideString

UserMessageType TUserMessageType

ClientUpgradeAvailable Boolean

RequestTimeout Integer

PrimarySearchType TSearchType

Struct TParamItem

The following table lists the fields defined in "TParamItem":

Field Data Type Documentation
Name WideString

DisplayName WideString

Comment WideString

Category WideString

Value Variant

DefaultValueIsNull Boolean

NullDisplayText WideString

FieldType TEIPDataType

CalculatedDateType TCalculatedDateType

CalculatedDateValue Integer

ParamStringType TParamStringType

Struct TReportObjects

The following table lists the fields defined in "TReportObjects":

Field Data Type Documentation
TableNames TStringArray

ViewNames TStringArray

StoredProcedureNames TStringArray

Struct TFieldInfo

The following table lists the fields defined in "TFieldInfo":

Field Data Type Documentation
Fieldname WideString

DataType TEIPDataType

InputParameter Boolean

Struct TEasyIPReportView

The following table lists the fields defined in "TEasyIPReportView":

Field Data Type Documentation
Name WideString

ReportType TReportViewType

ReportData WideString

Struct TEasyIPQuery

The following table lists the fields defined in "TEasyIPQuery":

Field Data Type Documentation
Name WideString

Comment WideString

QuerySQLs TQuerySQLs

Parameters TParamList

Struct TQuerySQL

The following table lists the fields defined in "TQuerySQL":

Field Data Type Documentation
ConnectionName WideString

SQL WideString

Default Boolean

Struct TEasyIPQueryReport

The following table lists the fields defined in "TEasyIPQueryReport":

Field Data Type Documentation
Name WideString

Comment WideString

ReportViews TEasyIPReportViews

QuerySQLs TQuerySQLs

Parameters TParamList

CatcheableErrors TCatcheableErrors

AdministratorReport Boolean

Struct TSimpleReport

The following table lists the fields defined in "TSimpleReport":

Field Data Type Documentation
Header WideString

Body WideString

Footer WideString

Struct TCatcheableError

The following table lists the fields defined in "TCatcheableError":

Field Data Type Documentation
CatchText WideString

CatchMessage WideString

Struct TDiscoveryIPAddressPingValues

The following table lists the fields defined in "TDiscoveryIPAddressPingValues":

Field Data Type Documentation
Update Boolean

Alive Boolean

ResponseTime Integer

ResponseTimestamp DateTime

Struct TFileInfo

The following table lists the fields defined in "TFileInfo":

Field Data Type Documentation
Filename WideString

Filesize Int64

ModifiedDate DateTime

CreatedDate DateTime

IsDir Boolean

Struct TUserSession

The following table lists the fields defined in "TUserSession":

Field Data Type Documentation
Username WideString

UserId Int64

ClientType TClientType

UserType TUserType

SessionCreated DateTime

LastAccessed DateTime

IPAddress WideString

SessionId WideString

Struct TEmailQueueItem

The following table lists the fields defined in "TEmailQueueItem":

Field Data Type Documentation
EmailId Int64

Recipients WideString

CCs WideString

BCCs WideString

Subject WideString

Status TEmailQueueItemStatus

ErrorMessage WideString

QueueTimestamp DateTime

ProcessedTimestamp DateTime

Struct TWebClientSettings

The following table lists the fields defined in "TWebClientSettings":

Field Data Type Documentation
Favourites TFavourites

Struct TFavourite

The following table lists the fields defined in "TFavourite":

Field Data Type Documentation
Description WideString

AutonomousNetworkId Int64

SubnetId Int64

Struct TExternalTool

The following table lists the fields defined in "TExternalTool":

Field Data Type Documentation
Caption WideString

ToolPath WideString

Parameters WideString

TableName WideString

Struct TDiscoveryARPValue

The following table lists the fields defined in "TDiscoveryARPValue":

Field Data Type Documentation
IPAddress WideString

MACAddress WideString

RouterInterfaceId Integer

Struct TChangeLogEntry

The following table lists the fields defined in "TChangeLogEntry":

Field Data Type Documentation
FieldName WideString

OldValue Variant

NewValue Variant

Struct TDiscoveryUpdateResult

The following table lists the fields defined in "TDiscoveryUpdateResult":

Field Data Type Documentation
UndoId Int64

SubnetId Integer

AddedIPAddressCount Integer

UpdatedIPAddressCount Integer

AddedUpdatedARPEntries Integer

Errors TStringArray

Struct TPingHistory

The following table lists the fields defined in "TPingHistory":

Field Data Type Documentation
PingID Int64

Alive Boolean

ResponseTime Integer

PingTimestamp DateTime

UserId Int64

Username WideString

Struct TPingHistoryResult

The following table lists the fields defined in "TPingHistoryResult":

Field Data Type Documentation
PingHistories TPingHistories

AverageResponseTime Integer

Struct TDiscoveryBot

The following table lists the fields defined in "TDiscoveryBot":

Field Data Type Documentation
DiscoveryBotId Int64

Name WideString

IPAddress WideString

LastSeen DateTime

Status TDiscoveryStatus

Enabled Boolean

QueuedCount Integer

DiscoveryId Int64

DiscoveryStatus WideString

DiscoveryProgress Integer

DiscoveryProgressMax Integer

Struct TQueuedDiscovery

The following table lists the fields defined in "TQueuedDiscovery":

Field Data Type Documentation
DiscoveryId Int64

UserId Int64

UserName WideString

DiscoveryBotId Int64

DiscoveryBotName WideString

DiscoveryBotIPAddress WideString

QueueTimeStamp DateTime

FinishedTimeStamp DateTime

NextRunTime DateTime

ScheduledRunTime DateTime

ScheduledRunFrequency TScheduleEventFrequencyType

Status TDiscoveryStatus

DiscoveryStatus WideString

DiscoveryProgress Integer

DiscoveryProgressMax Integer

Struct TDiscoveryBotSettings

The following table lists the fields defined in "TDiscoveryBotSettings":

Field Data Type Documentation
DiscoveryScript WideString

QueueCheckFrequency Integer

Struct TChangeLogItem

The following table lists the fields defined in "TChangeLogItem":

Field Data Type Documentation
LogId Int64

Username WideString

ChangeDateTime DateTime

Struct TParameterValue

The following table lists the fields defined in "TParameterValue":

Field Data Type Documentation
ParamName WideString

ParamValue Variant

Struct TUserInformation

The following table lists the fields defined in "TUserInformation":

Field Data Type Documentation
UserID Int64

Username AnsiString

FullName AnsiString

UserType TUserType

AuthenticationType TAuthenticationDetail

GroupID AnsiString

Email AnsiString

Created AnsiString

LastLogin AnsiString

UserDirectory AnsiString

UserPrivileges TUserPrivileges

Struct TLinkedIPAddress

The following table lists the fields defined in "TLinkedIPAddress":

Field Data Type Documentation
IPAddressID Int64

LinkID Int64

LongIPAddress WideString

ShortIPAddress WideString

SubnetID Int64

LongSubnet WideString

ShortSubnet WideString

AutonomousNetworkID Int64

AutonomousNetworkName WideString

LinkDescription WideString

Struct TLinkedIPAddressDescription

The following table lists the fields defined in "TLinkedIPAddressDescription":

Field Data Type Documentation
LinkedIPAddressDescriptionID Integer

Description WideString

Struct TEasyIPDeltaChange

The following table lists the fields defined in "TEasyIPDeltaChange":

Field Data Type Documentation
PrimaryKeyValue Int64

ChangeValues TEasyIPDeltaChangeValues

Struct TSimpleData

The following table lists the fields defined in "TSimpleData":

Field Data Type Documentation
Fields TSimpleDataFields

Data TSimpleRecords

Struct TSimpleDataField

The following table lists the fields defined in "TSimpleDataField":

Field Data Type Documentation
FieldName WideString

Struct TEasyIPUser

The following table lists the fields defined in "TEasyIPUser":

Field Data Type Documentation
GroupID Integer

Username WideString

UserType TUserType

AuthenticationType WideString

Email WideString

ForcePwdChange Boolean

AccountDisabled Boolean

Created DateTime

LastLogin DateTime

UserDirectory WideString

Deleted Boolean

DeletionDate DateTime

Struct TBaseEasyIPUser

The following table lists the fields defined in "TBaseEasyIPUser":

Field Data Type Documentation
UserID Int64

FullName WideString

Struct TEasyIPUserGroup

The following table lists the fields defined in "TEasyIPUserGroup":

Field Data Type Documentation
EasyIPUsers TEasyIPUsers

Struct TUndoItem

The following table lists the fields defined in "TUndoItem":

Field Data Type Documentation
UndoID Int64

Description WideString

UndoAction WideString

FocusedAutonomousNetwork Int64

Created DateTime

Struct TTemplateScript2

The following table lists the fields defined in "TTemplateScript2":

Field Data Type Documentation
ScriptEnabled Boolean

DescriptionHTML WideString

Struct TGlobalNetToolSettings

The following table lists the fields defined in "TGlobalNetToolSettings":

Field Data Type Documentation
General_DisplayEmptyFolders Boolean

WhoIs_DefaultServer WideString

WhoIs_UseDefaultServer Boolean

WhoIs_Servers TStringArray

Struct TThinfinitySettings

The following table lists the fields defined in "TThinfinitySettings":

Field Data Type Documentation
EasyIPServer WideString

Enums

The following table lists the Enums defined in "EasyIPLibrary":

TLogLevel

TUserType

TRefreshAction

TIPVers

TUserFunction

TUserFieldLookupType

TEIPDataType

TFieldUpdateAction

TFieldUpdateStatus

TExceptionServer

TExceptionClient

TUserMessageType

TServerType

TLogType

TScheduleEventFrequencyType

TScheduledEventType

TTemplateParamType

TTemplateType

TEventType

TSubnetItemType

TSecondaryItemType

TLicenceRestriction

TCalculatedDateType

TParamStringType

TReportViewType

TEncryptionType

TEmailQueueItemStatus

TClientType

TSearchOption

TSearchType

TFieldIndexType

TQueryExportType

TDiscoveryStatus

TChangeLogType

TClientUpgradeType

TSOAPMode

TTemplateScriptType

Enum TLogLevel

The following table lists the values defined in "TLogLevel":

Value Documentation
llNone

llError

llWarning

llInfo

llDebug

llDebug2

llDebug3

Enum TUserType

The following table lists the values defined in "TUserType":

Value Documentation
utUnknown

utGroup

utUser

utManager

utAdministrator

utSuperAdministrator

Enum TRefreshAction

The following table lists the values defined in "TRefreshAction":

Value Documentation
raAll

raChildren

raCurrentAutonomousNetwork

raCurrentItem

raCurrentItemParent

raCurrentItemIPAddresses

raExpandItem

raFocusParent

raFocusNewSubnet

Enum TIPVers

The following table lists the values defined in "TIPVers":

Value Documentation
ivGroup

ivIPv4

ivIPv6

Enum TUserFunction

The following table lists the values defined in "TUserFunction":

Value Documentation
ufUnknown

ufAJAXWebInterface

ufWindowsClient

ufNewGroup

ufRenameGroup

ufNewSubnet

ufAddChildSubnets

ufDeleteChildSubnets

ufDeleteObject

ufRemoveParentSubnet

ufMergeChildSubnets

ufAddIPAddresses

ufDeleteIPAddresses

ufHostDiscovery

ufReports

ufImport

ufExport

ufFieldEditorLayoutProperties

Enum TUserFieldLookupType

The following table lists the values defined in "TUserFieldLookupType":

Value Documentation
ltNone

ltEditable

ltFixed

Enum TEIPDataType

The following table lists the values defined in "TEIPDataType":

Value Documentation
edatUnknown

edatString

edatDateTime

edatFloat

edatCurrency

edatAutoInc

edatInteger

edatLargeInt

edatBoolean

edatMemo

edatBlob

edatWideString

edatWideMemo

edatLargeAutoInc

edatByte

edatShortInt

edatWord

edatSmallInt

edatCardinal

edatLargeUInt

edatGuid

edatXml

edatDecimal

edatSingleFloat

Enum TFieldUpdateAction

The following table lists the values defined in "TFieldUpdateAction":

Value Documentation
fuaAdd

fuaEdit

fuaDelete

fuaCreateIndex

fuaRemoveIndex

Enum TFieldUpdateStatus

The following table lists the values defined in "TFieldUpdateStatus":

Value Documentation
fusPending

fusComplete

fusFailed

Enum TExceptionServer

The following table lists the values defined in "TExceptionServer":

Value Documentation
esNone

esSubnetOverlapsExistingSubnets

esSubnetNotInUpstreamRange

esSubnetNotInDownstreamRange

esMandatoryFieldHasNoValue

esClientServerVersionMismatch

Enum TExceptionClient

The following table lists the values defined in "TExceptionClient":

Value Documentation
ecNone

Enum TUserMessageType

The following table lists the values defined in "TUserMessageType":

Value Documentation
umtInformation

umtWarning

umtError

umtExternal

Enum TServerType

The following table lists the values defined in "TServerType":

Value Documentation
stFirebirdEmbedded

stFirebirdServer

stMSSQL

Enum TLogType

The following table lists the values defined in "TLogType":

Value Documentation
ltAdministrator

ltClient

ltServer

Enum TScheduleEventFrequencyType

The following table lists the values defined in "TScheduleEventFrequencyType":

Value Documentation
sfOnce

sfHourly

sfDaily

sfWeekly

sfMonthly

Enum TScheduledEventType

The following table lists the values defined in "TScheduledEventType":

Value Documentation
seBackup

seHostDiscovery

Enum TTemplateParamType

The following table lists the values defined in "TTemplateParamType":

Value Documentation
tpDatabase

tpUserInputText

tpUserInputPassword

tpUserInputv4Subnet

tpUserInputv4IPAddress

tpUserInputv6Subnet

tpUserInputv6IPAddress

tpDatePart

tpGUID

tpInteger

tpUserInputTextMuliLine

tpScriptVariable

Enum TTemplateType

The following table lists the values defined in "TTemplateType":

Value Documentation
ttSubnet

ttIPAddresses

ttIPv4Subnet

ttIPv6Subnet

ttIPv4Addresses

ttIPv6Addresses

ttNone

Enum TEventType

The following table lists the values defined in "TEventType":

Value Documentation
etStartASyncOperation

etFinishASyncOperation

etStatus

etProgress

etProgressStatus

etDisconnect

Enum TSubnetItemType

The following table lists the values defined in "TSubnetItemType":

Value Documentation
sitUnknown

sitRoot

sitGroup

sitSubnet

Enum TSecondaryItemType

The following table lists the values defined in "TSecondaryItemType":

Value Documentation
setNone

setLimitedGroup

setMissingChildSubnets

Enum TLicenceRestriction

The following table lists the values defined in "TLicenceRestriction":

Value Documentation
lrReports

lrImport

lrExport

lrSubnetDiscovery

lrHostDiscovery

lrQueryBuilder

lrWebServer

Enum TCalculatedDateType

The following table lists the values defined in "TCalculatedDateType":

Value Documentation
cdNone

cdCurrentDateTime

cdMinutesBefore

cdMinutesAfter

cdHoursBefore

cdHoursAfter

cdDaysBefore

cdDaysAfter

cdWeeksBefore

cdWeeksAfter

Enum TParamStringType

The following table lists the values defined in "TParamStringType":

Value Documentation
pstNormal

pstTreePath

pstAutonomousNetworkID

pstSubnetID

pstUserID

pstUserName

pstIPv4Address

pstIPv6Address

pstIPAddress

pstSubnet

pstLowAddress

pstHighAddress

pstBroadcastAddress

pstIPVersion

Enum TReportViewType

The following table lists the values defined in "TReportViewType":

Value Documentation
rvtFastReport

rvtSimpleReport

Enum TEncryptionType

The following table lists the values defined in "TEncryptionType":

Value Documentation
enDES

enBlowFish

enTwoFish

enRijndael

enAES

Enum TEmailQueueItemStatus

The following table lists the values defined in "TEmailQueueItemStatus":

Value Documentation
eqsQueued

eqsCompleted

eqsFailed

Enum TClientType

The following table lists the values defined in "TClientType":

Value Documentation
ctWindowsClient

ctWindowsAdmin

ctWebClient

ctConsole

ctDiscoveryBot

ctScheduler

ctCustomClient

ctUnknown

Enum TSearchOption

The following table lists the values defined in "TSearchOption":

Value Documentation
soContains

soStartsWith

soExactMatch

soRegularExpression

Enum TSearchType

The following table lists the values defined in "TSearchType":

Value Documentation
stBasic

stFTS

Enum TFieldIndexType

The following table lists the values defined in "TFieldIndexType":

Value Documentation
fitNone

fitBoth

fitFTS

fitBasic

Enum TQueryExportType

The following table lists the values defined in "TQueryExportType":

Value Documentation
qetXML

qetCSV

qetHTML

Enum TDiscoveryStatus

The following table lists the values defined in "TDiscoveryStatus":

Value Documentation
dbsIdle

dbsWorking

dbsCancelling

dbsFailed

dbsCancelled

dbsComplete

Enum TChangeLogType

The following table lists the values defined in "TChangeLogType":

Value Documentation
ctRecordUpdatedByUser

ctRecordUpdatedByScript

ctRecordUpdatedByDiscovery

ctAddAutonomousNetwork

ctEditAutonomousNetwork

ctDeleteAutonomousNetwork

ctAddGroup

ctEditGroup

ctAddSubnet

ctAddChildSubnets

ctDeleteItem

ctMoveItem

ctDeleteChildren

ctAddIPAddresses

ctDeleteIPAddresses

ctMergeChildSubnets

ctRemoveParentSubnet

ctImportData

ctAddIPAddress

ctAddChildSubnet

ctDeleteIPAddress

Enum TClientUpgradeType

The following table lists the values defined in "TClientUpgradeType":

Value Documentation
cuOnlyClientWithSameVersionCanConnectWithUpgradeOption

cuEarlierClientsCanConnectWithUpgradeOption

cuEarlierClientsCanConnectNoUpgradeOption

cuOnlyMatchingClientsCanConnect

Enum TSOAPMode

The following table lists the values defined in "TSOAPMode":

Value Documentation
smDocumentLiteral

smRPCEncoding

smRPCLiteral

smUnknown

Enum TTemplateScriptType

The following table lists the values defined in "TTemplateScriptType":

Value Documentation
tsNone

tsValidation

tsValues

Arrays

The following table lists the Arrays defined in "EasyIPLibrary":

Array Element Type Documentation
TStringArray Widestring
Array of WideString
TVirtualFiles TVirtualFile
Array of TVirtualFile
TVirtualDirectories TVirtualDirectory
Array of TVirtualDirectory
TRefreshActionArray TRefreshAction
Array of TRefreshAction
TSubnetsArray TSubnet
Array of TSubnet
TUserTables TUserTable
Array of TUserTable
TInt64Array Int64
Array of Int64
TUserPrivilegeRights TUserPrivilegeRight
Array of TUserPrivilegeRight
TUserPrivileges TUserPrivilege
Array of TUserPrivilege
TUserFunctionArray TUserFunction
Array of TUserFunction
TUserFields TUserField
Array of TUserField
TUserFieldLookups TUserFieldLookup
Array of TUserFieldLookup
TFieldPendingUpdates TFieldPendingUpdate
Array of TFieldPendingUpdate
TFieldDataTypeInfos TFieldDataTypeInfo
Array of TFieldDataTypeInfo
TUserFieldDisplayOrders TUserFieldDisplayOrder
Array of TUserFieldDisplayOrder
TEasyIPDeltaChanges TEasyIPDeltaChange
Array of TEasyIPDeltaChange
TTableScripts TTableScript
Array of TTableScript
TUserInfoMessages TUserInfoMessage
Array of TUserInfoMessage
TDefaultValues TDefaultValue
Array of TDefaultValue
TEventSchedules TEventSchedule
Array of TEventSchedule
TTemplateParameters TTemplateParameter
Array of TTemplateParameter
TMissingSubnets TMissingSubnet
Array of TMissingSubnet
TEasyIPDeltaChangeValues TEasyIPDeltaChangeValue
Array of TEasyIPDelta
TSubnetIds TSubnetId
Array of TSubnetId
TDiscoveryIPAddressDataList TDiscoveryIPAddressData
Array of TDiscoveryIPAddressData
TDiscoveryIPAddressValues TDiscoveryIPAddressValue
Array of TDiscoveryIPAddressValue
TDiscoverableSubnets TDiscoverableSubnet
Array of TDiscoverableSubnet
TAuthenticationDetails TAuthenticationDetail
Array of TAuthenticationDetail
TParamList TParamItem
Array of TParamItem
TFieldInfos TFieldInfo
Array of TFieldInfo
TEasyIPReportViews TEasyIPReportView
Array of TEasyIPReportView
TQuerySQLs TQuerySQL
Array of TQuerySQL
TCatcheableErrors TCatcheableError
Array of TCatcheableError
TBinaryResults Binary
Array of Binary
TFileInfoArray TFileInfo
Array of TFileInfo
TUserSessions TUserSession
Array of TUserSession
TEmailQueueItems TEmailQueueItem
Array of TEmailQueueItem
TFavourites TFavourite
Array of TFavourite
TExternalTools TExternalTool
Array of TExternalTool
TDiscoveryARPValues TDiscoveryARPValue
Array of TDiscoveryARPValue
TVarArray Variant
Array of Variant
TChangeLogEntries TChangeLogEntry
Array of TChangeLogEntry
TPingHistories TPingHistory
Array of TPingHistory
TDiscoveryBots TDiscoveryBot
Array of TDiscoveryBot
TQueuedDiscoveries TQueuedDiscovery
Array of TQueuedDiscovery
TChangeLogItems TChangeLogItem
Array of TChangeLogItem
TParameterValues TParameterValue
Array of TParameterValue
TLinkedIPAddresses TLinkedIPAddress
Array of TLinkedIPAddress
TLinkedIPAddressDescriptions TLinkedIPAddressDescription
Array of TLinkedIPAddressDescription
VariantArray Variant

TSimpleDataFields TSimpleDataField
Array of TSimpleDataField
TSimpleRecords TVarArray
Array of TVarArray
TEasyIPUsers TEasyIPUser
Array of TEasyIPUser
TEasyIPUserGroups TEasyIPUserGroup
Array of TEasyIPUserGroup
Exceptions

The following table lists the Exceptions defined in "EasyIPLibrary":

EEasyIPServerError2(EEasyIPBaseError)
Easy-IP Server Exception
EEasyIPClientError(EEasyIPBaseError)
Easy-IP Client exception
EEasyIPCommonError(EEasyIPBaseError)
Easy-IP exception common to all applications
EEasyIPServerClientVersionError(EEasyIPBaseError)
This exception is raised when a client connection cannot be completed due to a client/server or interface version issue.
EEasyIPServerQueryAbortError(EEasyIPBaseError)
This Exception is raised when a user aborts a query
EEasyIPBaseError
The base Exception for all Easy-IP Exceptions
EEasyIPServerError
Deprecated, do not use
Exception EEasyIPServerError2

The following table lists the fields defined in "EEasyIPServerError2":

Field Data Type Documentation
Exception EEasyIPClientError

The following table lists the fields defined in "EEasyIPClientError":

Field Data Type Documentation
Exception EEasyIPCommonError

The following table lists the fields defined in "EEasyIPCommonError":

Field Data Type Documentation
Exception EEasyIPServerClientVersionError

The following table lists the fields defined in "EEasyIPServerClientVersionError":

Field Data Type Documentation
Exception EEasyIPServerQueryAbortError

The following table lists the fields defined in "EEasyIPServerQueryAbortError":

Field Data Type Documentation
Exception EEasyIPBaseError

The following table lists the fields defined in "EEasyIPBaseError":

Field Data Type Documentation
Exception EEasyIPServerError

The following table lists the fields defined in "EEasyIPServerError":

Field Data Type Documentation
ErrorCode TExceptionServer

Used RODL Files

The following table lists the external RODL files used by library "EasyIPLibrary":