Members

How it's used

Applicable Version

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 AddEx and AddSite.

Create a new Site.

HRESULT Add(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] int nAMID,

[in] BSTR bstrAMDB,

[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, as a full path for example, "c:\inetpub\eftroot\new site"

nAMID - Authentication manager identifier; this must be a number between 0 and 3 (inclusive), as follows:

   0  :  GlobalSCAPE EFT Server Authentication (proprietary flat file with an ".aud" extension)

   1  :  NTLM/Active Directory Authentication

   2  :  ODBC Authentication

   3  :  LDAP Authentication

bstrAMDB -  Authentication manager database configuration string.  This is specific to the Authentication Manager chosen by the nAMID parameter.

NT:  "NTLM=1;(DC=<<domain controller name>>;)(GROUP=<<group name>>;)"

AD: ";(DC=<<domain controller name>>;)(GROUP=<<group name>>;)"

ODBC: "<<dsn connection string>>"

LOCAL: "<<path to AUD file>>"

LDAP: "LDAPDB=<<path to AUD file>>;LDAPSERVER=<<host>>;LDAPPORT=<<port>>; BASEDN="<<base dn for users>>;USERFILTER=<<user query filter>>;USERATTRIBUTE=<<logon attribute>>;SSL={0|1};(USERNAME=<<ldap simple bind username>>;PASSWORD=<<ldap simple bind password>>;)"

bEncryptPasswords -  TRUE = database should contain encrypted passwords. This applies only to ODBC Authentication sites, and determines if password in the database are to be considered one-way hashed passwords or stored as plain-text in the columns (useful if you have external processes manipulating rows in the database).

nIP - Index of the site IP address. A "0" value means "all incoming."  A number greater than 0 refers to the index in the IP Address list for all addresses on the computer.

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.

All versions

Function AddADSite(bstrName As String, bstrRootFolder As String, bstrDomainContext As String, bstrAllowGroup As String, nIP As Int, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

See ICIADAuthManagerSettings - Active Directory Authentication Manager Settings Interface for AD-specific settings.

See also AddADSiteEx, below.

Create an AD-authenticated Site.

HRESULT AddADSite(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrDomainContext,

[in]BSTR bstrAllowGroup,

[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, e.g., "AD Site"

bstrRootFolder - Site root folder, e.g., "C:\sites\AD"

bstrDomainName - Default domain context for Active Directory, e.g., "" (required, but can be null)

bstrAllowGroup - Group name, e.g., "" (required, but can be null)

nIP - Index of the Site IP address, e.g., 0

nPort - Port number of the Site, e.g., 21

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.)

Example (VBScript):

Set Site = Sites.AddADSite("AD Site", "C:\sites\AD", "", "", 0, 21, True, True, True, True)

All versions

Function AddADSiteEx(bstrName As String, bstrRootFolder As String, bstrDomainContext As String, bstrAllowGroup 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 IPs.

HRESULT AddADSiteEx(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrDomainContext,

[in]BSTR bstrAllowGroup,

[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 Server v6.4 and later

Function AddEx (bzName As String, bzRootFolder As String, pdispAuthManagerSettings As Object, lIP As Int, lPort As Long, bCreateHomeFolder As Boolean, bFullPermissionForHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Create a new Site.

HRESULT AddEx(

[in] BSTR bzName,

[in] BSTR bzRootFolder,

[in] IDispatch* pdispAuthManagerSettings,

[in] int lIP,

[in] long lPort,

[in] VARIANT_BOOL bCreateHomeFolder,

[in] VARIANT_BOOL bFullPermissionForHomeFolder,

[in] VARIANT_BOOL bAutoStart,

[in] VARIANT_BOOL bCreateFTPFolders,

[out,retval] ICISite** pNewSite);

EFT Server v6.3 and later

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

See ICILDAPAuthManagerSettings - LDAP Authentication Manager Settings Interface for LDAP-specific settings.

See also AddLDAPSiteEx, below.

Create 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 AUD 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 Server will use the default values.

EFT Server 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,dc=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 Server 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 IPs.

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 Server 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 AddLocalSiteEx, below.

Create a new unauthenticated Site and retrieve the Site's ICISite interface.

HRESULT AddLocalSite(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrFilePath,

[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

bstrFilePath - Path to the file that will contain user data

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.AddLocalSite("Local Site", "C:\sites\Local",_

"C:\sites\Local.aud", 0, 21, True, True, True, True)

Example (C#):

CISite newSite = m_server.Sites().AddLocalSite("MySite", @"C:\Inetpub\EFTRoot\MySite", @"C:\Documents and Settings\All Users\Application Data\GlobalSCAPE\EFT Server Enterprise\MySite.aud", 0, 21, true, true, true, true);

All versions

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

Creates a new GS site, extended version, for multiple listening IPs.

HRESULT AddLocalSiteEx(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrFilePath,

[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 Server v6.4 and later

Function AddNTLMSite(bstrName As String, bstrRootFolder As String, bstrDomainName As String, bstrAllowGroup As String, nIP As Int, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

See ICIADAuthManagerSettings - Active Directory Authentication Manager Settings Interface for Windows-specific options.

See also AddNTLMSiteEx, below.

Create an NTLM-authenticated Site.

HRESULT AddNTLMSite(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrDomainName,

[in] BSTR bstrAllowGroup,

[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

bstrDomainName - NT domain name

bstrAllowGroup - NT group name

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.AddNTLMSite("NTLM Site", "C:\sites\NTLM", "", 0, 21, True, True, True, True)

All versions

Function AddNTLMSiteEx(bstrName As String, bstrRootFolder As String, bstrDomainName As String, bstrAllowGroup As String, IP, nPort As Long, bCreateHomeFolder As Boolean, bPermHomeFolder As Boolean, bAutoStart As Boolean, bCreateFTPFolders As Boolean) As CISite

Creates a new NT site, extended version for multiple listening ips.

HRESULT AddNTLMSiteEx(

[in] BSTR bstrName,

[in] BSTR bstrRootFolder,

[in] BSTR bstrDomainName,

[in] BSTR bstrAllowGroup,

[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 Server v6.4 and later

Function AddODBCSite(bstrName As String, bstrRootFolder As String, bstrDSN 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 ICIOCBCAuthManagerSettings - ODBC Authentication Manager Settings Interface for ODBC-specific settings.

See also AddODBCSiteEx, below.

Create 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", "", 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.

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 Server 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 Server 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 ips.

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 Server v6.4 and later

Function Count() As Long

Returns the number of Sites defined.

HRESULT Count(

[out, retval] long* prop);

All versions

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