FaxServer object

The FaxServer object is used by a fax client application to manage a connection to the fax service. The object includes methods to create and terminate connections with a fax server, and to retrieve information about a connected fax server. The object also includes methods to store extension configuration properties.

Members

The FaxServer object has these types of members:

• Methods
• Properties

Methods

The FaxServer object has these methods.

Method	Description
Connect	The Connect method connects a fax client application to the specified fax server.
Disconnect	The Disconnect method terminates a fax client application's connection to a fax server. The method fails if the client is not connected to an active fax server.
GetDeviceProviders	The GetDeviceProviders method creates a FaxDeviceProviders object, a collection of FSPs that are currently registered with the fax service. You can use the FaxDeviceProviders object to enumerate the FSPs associated with a fax server and to create and access FaxDeviceProvider objects for them.
GetDevices	The GetDevices method creates a FaxDevices object, a collection of all the fax devices exposed by all the FSPs currently registered with the fax service.
GetExtensionProperty	The GetExtensionProperty method retrieves an extension configuration property stored at the server level.
ListenToServerEvents	The ListenToServerEvents method registers the FaxServer object to receive notifications about one or more types of server events, or to stop these notifications.
RegisterDeviceProvider	The RegisterDeviceProvider method registers a FSP with the fax service. Registration takes place after the fax service restarts.
RegisterInboundRoutingExtension	The RegisterInboundRoutingExtension method registers a fax inbound routing extension with the fax service. Registration takes place after the fax service restarts.
SetExtensionProperty	The SetExtensionProperty method stores an extension configuration property at the server level.
UnregisterDeviceProvider	The UnregisterDeviceProvider method unregisters (removes the registration of) an existing device provider. Unregistration will take place only after the fax server is restarted.
UnregisterInboundRoutingExtension	The UnregisterInboundRoutingExtension method unregisters an existing inbound routing extension. Unregistration will take place only after the fax server is restarted.

 

Properties

The FaxServer object has these properties.

Property	Access type	Description
Activity	Read-only	The Activity property creates a FaxActivity configuration object. The object permits a fax client application to access information about the activity on a connected fax server, and the fax server status.
APIVersion	Read-only	The APIVersion property is a value that indicates the version of the fax server API.
Configuration	Read-only	The Configuration property holds a IFaxConfiguration object. The object permits a fax client application to access information about the configuration of the connected fax server.
CurrentAccount	Read-only	The CurrentAccount property returns the fax account for the user account that has connected to the fax server.
Debug	Read-only	The Debug property is a Boolean value that indicates whether the fax server was created in a debug environment.
FaxAccountSet	Read-only	The FaxAccountSet property returns a IFaxAccountSet object used to manage the fax accounts on the fax server.
Folders	Read-only	The Folders property accesses a FaxFolders configuration object. You can use the object to access the folders, jobs, and messages on a connected fax server.
InboundRouting	Read-only	The InboundRouting property creates a FaxInboundRouting configuration object. The object permits access to an inbound fax routing extension and its methods.
LoggingOptions	Read-only	The LoggingOptions property creates a FaxLoggingOptions configuration object. The object permits configuration of both the activity logging options and the event logging categories that the fax service uses.
MajorBuild	Read-only	The MajorBuild property is a value that specifies the major part of the build number for the fax service.
MajorVersion	Read-only	The MajorVersion property is a value that specifies the major part of the version number for the fax service.
MinorBuild	Read-only	The MinorBuild property is a value that specifies the minor part of the build number for the fax service.
MinorVersion	Read-only	The MinorVersion property is a value that specifies the minor part of the version number for the fax service.
OutboundRouting	Read-only	The OutboundRouting property creates a FaxOutboundRouting configuration object. The object permits users to configure outbound routing groups and rules.
ReceiptOptions	Read-only	The ReceiptOptions property creates a FaxReceiptOptions configuration object. The object permits a fax client application to set and retrieve the receipt configuration that the fax service uses to send fax receipts.
RegisteredEvents	Read-only	The RegisteredEvents property is a value from an enumeration that indicates the types of fax service events a client application is listening for.
Security	Read-only	The Security property creates a FaxSecurity configuration object. The object permits the calling application to set and retrieve a security descriptor for the fax server.
Security2	Read-only	The Security2 property returns a IFaxSecurity2 object used to configure security on the fax server.
ServerName	Read-only	The ServerName property retrieves the name of the active fax server to which the fax client is connected.

 

Remarks

You must call the Connect method to initiate a connection with an active fax server before calling other methods on the FaxServer object, and before accessing most of the extended Component Object Model (COM) fax objects. A fax server connection is not required to access a FaxDocument object.

The FaxServer object is the root object of the fax service extended COM implementation. Call the CoCreateInstance function to create a FaxServer object. After you obtain a connection to an active fax server, you can create and access other objects to manage fax jobs, view the inbound and outbound fax archives, and configure the fax server.

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
DLL	Fxscomex.dll
IID	CLSID_FaxServer