IFaxDevice interface (faxcomex.h)
The IFaxDevice interface defines a configuration object used by a fax client application to retrieve and set fax device information, and to add and remove fax routing methods associated with a fax device. The object also includes methods to retrieve and set extension configuration properties stored at the device level. The object defined by the IFaxDevice interface represents a single device associated with a fax server.
Inheritance
The IFaxDevice interface inherits from the IDispatch interface. IFaxDevice also has these types of members:
Methods
The IFaxDevice interface has these methods.
| IFaxDevice::AnswerCall The IFaxDevice::AnswerCall method causes the fax device to answer an incoming call. |
| IFaxDevice::get_CSID The IFaxDevice::get_CSID property is a null-terminated string that contains the called station identifier (CSID) for the device. (Get) |
| IFaxDevice::get_Description The IFaxDevice::get_Description property is a null-terminated string that contains a user-friendly description for the fax device. This string is suitable for display to users. (Get) |
| IFaxDevice::get_DeviceName The IFaxDevice::get_DeviceName property is a null-terminated string that contains the name of the fax device. |
| IFaxDevice::get_Id The Id IFaxDevice::get_Id is a numeric value that uniquely identifies a fax device. |
| IFaxDevice::get_PoweredOff The IFaxDevice::get_PoweredOff property is a Boolean value that indicates whether the fax device is currently available for sending and receiving faxes. |
| IFaxDevice::get_ProviderUniqueName The IFaxDevice::get_ProviderUniqueName property is a null-terminated string that contains the unique name for the fax service provider (FSP) associated with the device. |
| IFaxDevice::get_ReceiveMode The ReceiveMode property is a value from the FAX_DEVICE_RECEIVE_MODE_ENUM enumeration that defines the way a device answers an incoming call. (Get) |
| IFaxDevice::get_ReceivingNow The IFaxDevice::get_ReceivingNow property is a Boolean value that indicates whether the fax device is receiving a fax at the moment the property is retrieved (the status could change immediately thereafter). |
| IFaxDevice::get_RingingNow The IFaxDevice::get_RingingNow property is a Boolean value that indicates whether the fax device is ringing at the moment the property is retrieved (the status could change immediately thereafter). |
| IFaxDevice::get_RingsBeforeAnswer The IFaxDevice::get_RingsBeforeAnswer property is a number that specifies the number of rings that occur before the fax device answers an incoming fax call. (Get) |
| IFaxDevice::get_SendEnabled The IFaxDevice::get_SendEnabled property is a Boolean value that indicates whether the fax device is enabled for sending faxes. (Get) |
| IFaxDevice::get_SendingNow The IFaxDevice::get_SendingNow property is a Boolean value that indicates whether the fax device is sending a fax at the moment the property is retrieved (the status could change immediately thereafter). |
| IFaxDevice::get_TSID The IFaxDevice::get_TSID property is a null-terminated string that contains the transmitting station identifier (TSID) for the device. (Get) |
| IFaxDevice::get_UsedRoutingMethods The IFaxDevice::get_UsedRoutingMethods property is an array of strings that contains the GUIDs associated with the routing methods that the device uses, where each GUID represents an inbound routing method (FaxInboundRoutingMethod). |
| IFaxDevice::GetExtensionProperty The IFaxDevice::get_GetExtensionProperty method retrieves an extension configuration property stored at the device level. |
| IFaxDevice::put_CSID The IFaxDevice::get_CSID property is a null-terminated string that contains the called station identifier (CSID) for the device. (Put) |
| IFaxDevice::put_Description The IFaxDevice::get_Description property is a null-terminated string that contains a user-friendly description for the fax device. This string is suitable for display to users. (Put) |
| IFaxDevice::put_ReceiveMode The ReceiveMode property is a value from the FAX_DEVICE_RECEIVE_MODE_ENUM enumeration that defines the way a device answers an incoming call. (Put) |
| IFaxDevice::put_RingsBeforeAnswer The IFaxDevice::get_RingsBeforeAnswer property is a number that specifies the number of rings that occur before the fax device answers an incoming fax call. (Put) |
| IFaxDevice::put_SendEnabled The IFaxDevice::get_SendEnabled property is a Boolean value that indicates whether the fax device is enabled for sending faxes. (Put) |
| IFaxDevice::put_TSID The IFaxDevice::get_TSID property is a null-terminated string that contains the transmitting station identifier (TSID) for the device. (Put) |
| IFaxDevice::Refresh The IFaxDevice::Refresh method refreshes FaxDevice object information from the fax server. When the IFaxDevice::Refresh method is called, any configuration changes made after the last IFaxDevice::Save method call are lost. |
| IFaxDevice::Save The IFaxDevice::Save method saves the FaxDevice object's data. |
| IFaxDevice::SetExtensionProperty The IFaxDevice::SetExtensionProperty method stores an extension configuration property at the device level. |
| IFaxDevice::UseRoutingMethod The IFaxDevice::UseRoutingMethod method adds an inbound fax routing method to or removes a fax routing method (FaxInboundRoutingMethod) from the list of routing methods associated with the fax device. |
Remarks
A default implementation of IFaxDevice is provided as the FaxDevice object.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | faxcomex.h |