IServer Interface

IServer is the root object for accessing the e-FAQ server. Use the IServer interface to connect to an e-FAQ server, or to determine whether a connection to the server exists.

Methods

Connect

The Connect method establishes a connection with an e-FAQ server. The e-FAQ server name, and client identifier must be passed as arguments.

CreateNewAlias

The CreateNewAlias method creates a new alias object, which you can later add to a FAQ by using the IAliases::Add method.

CreateNewEntry

CreateNewEntry creates an empty entry object, which can be added to a FAQ collection using the FAQ.Entries.Add method.

CreateNewFAQ

The CreateNewFAQ method creates an empty FAQ object. To add this new object to the server, use the IFAQs::Add method.

CreateQuery

The CreateQuery method creates a new query object.

GetEntry

The method returns the entry object specified by the EntryID (name) you supply as a string. A NULL entry object is returned if the specified EntryID does not exist.

GetFAQ

The method returns the FAQ object specified by the name or identifier that you supply as an argument. A NULL object is returned if the name or identifier does not exist.

GetServerInfo

This method returns the number of licenses, version and other information about the e-FAQ server.

Properties

ClientId (Get)

This read-only property returns the client identifier passed to the e-FAQ server using the IServer::Connect method. The client id can be used to identify the client in logs. The client id can be any string up to 64 characters long.

FAQs (Get)

The FAQs property returns a collection of FAQs from the e-FAQ server as an IFAQs object.

IsConnected (Get)

IsConnected is a read-only property that returns True if a connection has been established with an e-FAQ server. If no connection is active, the property returns False.

Name (Get)

The Name property is read-only. It returns the name of the connected e-FAQ server.

ServerNotifications (Get)

This object registers for notification callbacks.