FAX_SERVER_EVENTS_TYPE_ENUM enumeration (faxcomex.h)

The FAX_SERVER_EVENTS_TYPE_ENUM enumeration defines the types of events the fax service sends to client applications that are listening for events. The members of this enumeration are bit values and can be used in combination.

Syntax

typedef enum FAX_SERVER_EVENTS_TYPE_ENUM {
  fsetNONE = 0,
  fsetIN_QUEUE = 0x1,
  fsetOUT_QUEUE = 0x2,
  fsetCONFIG = 0x4,
  fsetACTIVITY = 0x8,
  fsetQUEUE_STATE = 0x10,
  fsetIN_ARCHIVE = 0x20,
  fsetOUT_ARCHIVE = 0x40,
  fsetFXSSVC_ENDED = 0x80,
  fsetDEVICE_STATUS = 0x100,
  fsetINCOMING_CALL = 0x200
} ;

Constants

fsetNONE Value: 0 No events are sent.
fsetIN_QUEUE Value: 0x1 The client requests notifications about fax jobs in the incoming queue. When the status of an incoming fax job changes, the fax service issues a notification of this type.
fsetOUT_QUEUE Value: 0x2 The client requests notification about fax jobs in the outgoing queue. When the status of an outgoing fax job changes, the fax service issues a notification of this type.
fsetCONFIG Value: 0x4 The client requests notifications about changes to the fax server configuration. When the configuration data changes, the fax service issues a notification of this type.
fsetACTIVITY Value: 0x8 The client requests notifications about the fax server activity. When the activity status of the fax server changes, the fax service issues a notification of this type.
fsetQUEUE_STATE Value: 0x10 The client requests notifications about changes in the status of the fax job queue. When the status of the queue changes, the fax service issues a notification.
fsetIN_ARCHIVE Value: 0x20 The client requests notifications about the addition or removal of fax messages from the incoming archive. When a message is removed from the archive, the fax service issues a notification. The notification includes the archive type (inbound) and the unique ID of the fax message.
fsetOUT_ARCHIVE Value: 0x40 The client requests notifications about the addition or removal of fax messages from the outgoing archive. When a message is removed from the archive, the fax service issues a notification. The notification includes the archive type (outbound) and the unique ID of the fax message.
fsetFXSSVC_ENDED Value: 0x80 The client requests notifications when the fax service stops executing.
fsetDEVICE_STATUS Value: 0x100 The client requests notifications when a device status changes.
fsetINCOMING_CALL Value: 0x200 The client requests notifications when there is an incoming call.

Remarks

The following table lists the IFaxServerNotify methods called by each member.

Name	IFaxServerNotify method called
fsetNONE	None
fsetIN_QUEUE	OnIncomingJobAdded OnIncomingJobRemoved OnIncomingJobChanged
fsetOUT_QUEUE	OnOutgoingJobAdded OnOutgoingJobRemoved OnOutgoingJobChanged
fsetCONFIG	OnReceiptOptionsChange OnActivityLoggingConfigChange OnSecurityConfigChange OnEventLoggingConfigChange OnOutgoingQueueConfigChange OnOutgoingArchiveConfigChange OnIncomingArchiveConfigChange OnDevicesConfigChange OnOutboundRoutingGroupsConfigChange OnOutboundRoutingRulesConfigChange
fsetACTIVITY	OnServerActivityChange
fsetQUEUE_STATE	OnQueuesStatusChange
fsetIN_ARCHIVE	OnIncomingMessageAdded OnIncomingMessageRemoved
fsetOUT_ARCHIVE	OnOutgoingMessageAdded OnOutgoingMessageRemoved
fsetFXSSVC_ENDED	OnServerShutDown
fsetDEVICE_STATUS	OnDeviceStatusChange
fsetINCOMING_CALL	OnNewCall

 

The following table lists the IFaxServerNotify2 methods called by each member.

Name	IFaxServerNotify2 method called
fsetNONE	None
fsetIN_QUEUE	OnIncomingJobAdded OnIncomingJobRemoved OnIncomingJobChanged
fsetOUT_QUEUE	OnOutgoingJobAdded OnOutgoingJobRemoved OnOutgoingJobChanged
fsetCONFIG	OnReceiptOptionsChange OnActivityLoggingConfigChange OnSecurityConfigChange OnEventLoggingConfigChange OnOutgoingQueueConfigChange OnOutgoingArchiveConfigChange OnIncomingArchiveConfigChange OnDevicesConfigChange OnOutboundRoutingGroupsConfigChange OnOutboundRoutingRulesConfigChange OnGeneralServerConfigChanged
fsetACTIVITY	OnServerActivityChange
fsetQUEUE_STATE	OnQueuesStatusChange
fsetIN_ARCHIVE	OnIncomingMessageAdded OnIncomingMessageRemoved
fsetOUT_ARCHIVE	OnOutgoingMessageAdded OnOutgoingMessageRemoved
fsetFXSSVC_ENDED	OnServerShutDown
fsetDEVICE_STATUS	OnDeviceStatusChange
fsetINCOMING_CALL	OnNewCall

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	faxcomex.h

See also

IFaxServer::ListenToServerEvents

IFaxServerNotify