2.2.63 FAX_ENUM_EVENT_TYPE

  • Article

The FAX_ENUM_EVENT_TYPE enumeration defines types of events that the caller can specify to receive.<25>

 typedef  enum 
 {
   FAX_EVENT_TYPE_LEGACY = 0x00000000,
   FAX_EVENT_TYPE_IN_QUEUE = 0x00000001,
   FAX_EVENT_TYPE_OUT_QUEUE = 0x00000002,
   FAX_EVENT_TYPE_CONFIG = 0x00000004,
   FAX_EVENT_TYPE_ACTIVITY = 0x00000008,
   FAX_EVENT_TYPE_QUEUE_STATE = 0x00000010,
   FAX_EVENT_TYPE_IN_ARCHIVE = 0x00000020,
   FAX_EVENT_TYPE_OUT_ARCHIVE = 0x00000040,
   FAX_EVENT_TYPE_FXSSVC_ENDED = 0x00000080,
   FAX_EVENT_TYPE_DEVICE_STATUS = 0x00000100,
   FAX_EVENT_TYPE_NEW_CALL = 0x00000200,
   FAX_EVENT_TYPE_LOCAL_ONLY = 0x80000000
 } FAX_ENUM_EVENT_TYPE;

FAX_EVENT_TYPE_LEGACY: The type used for all legacy events. Legacy events are events that are requested by fax API version FAX_API_VERSION_0 (0x00000000) and FAX_API_VERSION_1 (0x00010000) fax clients to protocol version FAX_API_VERSION_2 (0x00020000) and FAX_API_VERSION_3 (0x00030000) fax servers. For more information, see FAX_ConnectFaxServer (section 3.1.4.1.10), FAX_StartServerNotification (section 3.1.4.1.100), FAX_StartServerNotificationEx (section 3.1.4.1.101), FaxObs_StartClientServer (section 3.1.4.2.31), and FAX_ClientEventQueue (section 3.2.4.2) methods. A legacy event signaled with a FAX_ClientEventQueue call is described by a FAX_EVENT (section 2.2.66) structure that does not include a member that describes the event type (the legacy events do not have event types; thus the need to describe their type by a common, generic, FAX_ENUM_EVENT_TYPE (section 2.2.63) value). This value SHOULD NOT be supported by protocol version FAX_API_VERSION_0 (0x00000000) and FAX_API_VERSION_1 (0x00010000) fax servers.<26>

The following FAX_ENUM_EVENT_TYPE values describe the type of the extended events. For more information about extended events, see the FAX_StartServerNotificationEx, FAX_StartServerNotificationEx2 (section 3.1.4.1.102), and FAX_ClientEventQueueEx (section 3.2.4.3) methods. An extended event signaled with a FAX_ClientEventQueueEx call is described by a FAX_EVENT_EX (section 2.2.67) or FAX_EVENT_EX_1 (section 2.2.68) structure, each of these structures including a member (called EventType for FAX_EVENT_EX and EventType4 for FAX_EVENT_EX_1) containing the FAX_ENUM_EVENT_TYPE value describing the type of the respective extended event.

FAX_EVENT_TYPE_IN_QUEUE: Requests notification about fax jobs in the incoming queue. Whenever the state of an incoming fax job changes, a notification of that type is issued.

FAX_EVENT_TYPE_OUT_QUEUE: Requests notification about fax jobs in the outgoing queue. Whenever the state of an outgoing fax job changes, a notification of that type is issued.

FAX_EVENT_TYPE_CONFIG: Requests notifications about fax server configuration changes. Whenever the configuration of the fax server changes, a notification of that type is issued.

FAX_EVENT_TYPE_ACTIVITY: Requests notifications about the fax server activity. Whenever the activity state of the fax server changes, a notification of that type is issued.

FAX_EVENT_TYPE_QUEUE_STATE: Requests notifications about the fax Queue State (section 3.1.1). Whenever the state of the fax queue changes, a notification of that type is issued.

FAX_EVENT_TYPE_IN_ARCHIVE: Requests notifications about the removal of fax messages from the incoming messages archive. Whenever a message is removed from the archive, the archive type and the message unique identifier are issued in a notification message.

FAX_EVENT_TYPE_OUT_ARCHIVE: Requests notifications about the removal of fax messages from the outgoing messages archive. Whenever a message is removed from the archive, the archive type and the message unique identifier are issued in a notification message.

FAX_EVENT_TYPE_FXSSVC_ENDED: Specifies the shutdown of the fax server.

FAX_EVENT_TYPE_DEVICE_STATUS: Specifies that the status of a device has changed.

FAX_EVENT_TYPE_NEW_CALL: Specifies that a new incoming call was detected by the fax service.

FAX_EVENT_TYPE_LOCAL_ONLY: Specifies that the fax client (acting as RPC server) needs to accept only local (same computer) notifications.<27>