ICISites Interface

Use the ICISites interface to create new Sites or to retrieve information about the Sites on the Server. (See also ICISite for details about an individual Site.)

interface ICISites : IDispatch

Members (Listed alphabetically)

Function Add(bstrName As String, bstrRootFolder As String, nAMID As Int, bstrAMDB As String, bEncryptPasswords As Boolean, nIP As Int, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

See also AddLDAPSiteEx, below.

Creates an LDAP-authenticated Site.

HRESULT AddLDAPSite(
[in] BSTR bstrName,
[in] BSTR bstrRootFolder,
[in] BSTR bstrDomainContext,
[in] int nIP, long nPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bPermHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,
[out, retval] ICISite** prop);

bstrName - New site name

bstrRootFolder - Site root folder

bstrDomainContext - A semicolon-separated list of name/value pairs that defines the LDAP domain components. (See Configuration Notes below for details of how to compose this string.)

bstrAllowGroup - LDAP group name (not used in v6.1)

nIP - Index of the site IP address

nPort - Port number of the site

bCreateHomeFolder - TRUE means that a home folder for new site users should be created

bPermHomeFolder - TRUE means that new site users should be granted full permissions in their home folders

bAutoStart - TRUE means that the site should start automatically

bCreateFTPFolders - TRUE means to create standard FTP folders (Usr, Bin, Incoming, Pub) (v6.1 and later)

You can also call Add(), setting "3" as the nAMID parameter to create an LDAP site.

Configuration Notes

The bstrDomainContext string must be composed properly to define the parameters of the LDAP Site. The syntax is a semicolon-separated list of name/value pairs that defines the LDAP options.

The entire string is:

LDAPSERVER={IP or Hostname for LDAP server};LDAPPORT={port on LDAP server};BASEDN={base dn for users};USERFILTER={filter for LDAP query to return users};USERATTRIBUTE={what user attribute to use as client login};TYPE={1 for anonymous bind, 0 for simple bind};USERNAME={cn of the user to bind as for querying users};PASSWORD={password for that user};LDAPDB={path to database file};SSL={0 for no SSL, 1 for SSL};USESEARCHSCOPE={1 to set search scope, 0 otherwise};SEARCHSCOPE={search scope: 0 => base, 1 => one level, =>subtree};USESEARCHSIZELIMIT={1 to override search page size, 0 otherwise};SEARCHSIZELIMIT={new search page size};USETIMEOUT={1 to use timeout, 0 otherwise};TIMEOUT={timeout in seconds};USEVERSION={1 to use specific version, otherwise 0};VERSION={LDAP version (2 or 3)};USEPAGECONTROL={1 to use LDAP server side page control, 0 otherwise};USEREFERRALS={1 to turn on referral changing; 0 otherwise};USESEARCHATTRIBUTES={1 to select attributes; 0 otherwise };SEARCHATTRIBUTES={search attributes};

You do not have to include the entire string. Any options from USESEARCHSCOPE to the end can be omitted and EFT will use the default values.

EFT ignores the TYPE attribute; it is only used here to set the radio button on the LDAP Authentication Options dialog box.

Example (VBScript):

(type all on one line without spaces; shown with line breaks below for readability):

Set Site = Sites.AddLDAPSite("LDAP Site", "C:\sites\LDAP", "", 0, 21, True, True, True, True)
LDAPSERVER=fileserver;
LDAPPORT=389;
BASEDN=dc=s5development,c=local;
USERFILTER=(objectClass=person);
USERATTRIBUTE=cn;
TYPE=0;
USERNAME=cn=Ivan Smithe,cn=users,dc=development,dc=local;
PASSWORD=XXX;
LDAPDDB=C:\EFT AppData\MySite.aud;SSL=0;
USESEARCHSCOPE=1;
SEARCHSCOPE=2;
USESEARCHSIZELIMIT=1;
SEARCHSIZELIMIT=1000;
USETIMEOUT=1;
TIMEOUT=60;
USEVERSION=1;
VERSION=3;
USEPAGECONTROL=1;
USEREFERRALS=0;
USESEARCHATTRIBUTES=1;
SEARCHATTRIBUTES=mail,e-mail,name,cn;

EFT v4.3.4 and later

Function AddLDAPSiteEx(bstrName As String, bstrRootFolder As String, bstrDomainContext As String, IP, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Creates a new AD Site, extended version for multiple listening IP addresses.

HRESULT AddLDAPSiteEx(
in] BSTR bstrName, [in] BSTR bstrRootFolder,
[in] BSTR bstrDomainContext,
[in] VARIANT IP, long nPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bPermHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,
[out, retval] ICISite** prop);

EFT v6.4 and later

Function AddLocalSite(bstrName As String, bstrRootFolder As String, bstrFilePath As String, nIP As Int, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

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

See also AddODBCSiteEx, below.

Creates an ODBC-authenticated Site.

HRESULT AddODBCSite(
[in] BSTR bstrName,
[in] BSTR bstrRootFolder,
[in] BSTR bstrDSN,
[in] VARIANT_BOOL bEncryptPasswords,
[in] int nIP,
[in] long nPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bPermHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,}
[out, retval] ICISite** prop);

bstrName - New site name

bstrRootFolder - Site root folder

bstrDSN - Database DSN

bEncryptPasswords - TRUE = database should contain encrypted passwords

nIP - Index of the site IP address

nPort - Port number of the site

bCreateHomeFolder - TRUE = home folder for new site users should be created

bPermHomeFolder - TRUE= new site users should be granted full permissions in their home folders

bAutoStart - TRUE = site should start automatically

bCreateFTPFolders - TRUE = create standard FTP folders (Usr, Bin, Incoming, Pub) (v6.1 and later)

Example (VBScript):

Set Site = Sites.AddODBCSite("ODBC Site", 
"C:\sites\ODBC", "myDSN;", True, 0, 21, True, True, True, True)

All versions

Function AddODBCSiteEx(bstrName As String, bstrRootFolder As String, bstrDSN As String, bEncryptPasswords As Boolean, IP, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Creates a new ODBC Site, extended version for multiple listening IP addresses.

HRESULT AddODBCSiteEx(
[in] BSTR bstrName, 
[in] BSTR bstrRootFolder,
[in] BSTR bstrDSN, 
[in] VARIANT_BOOL bEncryptPasswords,
[in] VARIANT IP, 
[in] long nPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bPermHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,
[out, retval] ICISite** prop);

EFT v6.4 and later

Function AddSite(bstrName As String, bstrRootFolder As String, nAMID As Int, bstrAMDB As String, bEncryptPasswords As Boolean, IP, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Creates a new site.

HRESULT AddSite(
[in] BSTR bstrName,
[in] BSTR bstrRootFolder,
[in] int nAMID,
[in] BSTR bstrAMDB,
[in] VARIANT_BOOL bEncryptPasswords,
[in] VARIANT IP, 
[in] long nPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bPermHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,
[out, retval] ICISite** prop);

EFT v6.4 and later

Function AddSiteEx(bzName As String, bzRootFolder As String, pdispAuthManagerSettings As Object, IP, lPort As Long, bCreateHomeFolder As Boolean, bFullPermissionForHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Creates a new Site, extended version for multiple listening IP addresses.

HRESULT AddSiteEx(
[in] BSTR bzName,
[in] BSTR bzRootFolder,
[in] IDispatch* pdispAuthManagerSettings,
[in] VARIANT IP,
[in] long lPort,
[in] VARIANT_BOOL bCreateHomeFolder,
[in] VARIANT_BOOL bFullPermissionForHomeFolder,
[in] VARIANT_BOOL bAutoStart,
[in] VARIANT_BOOL bCreateFTPFolders,
[out,retval] ICISite** pNewSite);

EFT v6.4 and later

Function Count() As Long

Returns the number of Sites defined.

HRESULT Count([out, retval] long* prop);

All versions

Function GetNewSite() As CINewSite

Retrieves interface for new site

HRESULT CreateSite([in] IDispatch* pdispNewSite, [out,retval] ICISite** pNewSite);

EFT v8.1 and later

Function CreateSite(pdispNewSite As Object) As CISite

Retrieves interface for new site

HRESULT GetNewSite([out,retval] ICINewSite** prop);

EFT v8.1 and later

Function Item(nIndex As Long) As CISite

For an example using this method, refer to the CreateSite or RemoveSite script in Script Examples.

Returns an item by index. The Index value must be between 0 and (Count-1).

HRESULT Item([in] long nIndex,[out, retval] ICISite** prop);

Example (VBScript):

Set Sites = Server.Sites 'Retrieve list of sites
Set Site = Sites.Item(0) 'Instantiate the first one

Example (C#):

CISite site = sites.Item(i);

All versions

Function SiteByID(ID As Long) As CISite

Retrieves the properties of a Site by ID.

HRESULT SiteByID(
[in] long ID,
[out, retval] ICISite** prop);

All versions

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.
8.1 | 202404030947 | April 2024