Share via


FaxDevice object

The FaxDevice configuration object is 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 FaxDevice object represents a single device associated with a fax server.

Members

The FaxDevice object has these types of members:

Methods

The FaxDevice object has these methods.

Method Description
AnswerCall The AnswerCall method causes the fax device to answer an incoming call.
GetExtensionProperty The GetExtensionProperty method retrieves an extension configuration property stored at the device level.
Refresh The Refresh method refreshes FaxDevice object information from the fax server. When the Refresh method is called, any configuration changes made after the last Save method call are lost.
Save The Save method saves the FaxDevice object's data.
SetExtensionProperty The SetExtensionProperty method stores an extension configuration property at the device level.
UseRoutingMethod The 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.

 

Properties

The FaxDevice object has these properties.

Property Access type Description
[CSID](-mfax-faxdevice-csid-vb.md)
Read/write
The [CSID](-mfax-faxdevice-csid-vb.md) property is a null-terminated string that contains the CSID for the device.
[Description](-mfax-faxdevice-description-vb.md)
Read/write
The [Description](-mfax-faxdevice-description-vb.md) property is a null-terminated string that contains a user-friendly description for the fax device. This string is suitable for display to users.
[DeviceName](-mfax-faxdevice-devicename-vb.md)
Read-only
The [DeviceName](-mfax-faxdevice-devicename-vb.md) property is a null-terminated string that contains the name of the fax device.
[Id](-mfax-faxdevice-id-vb.md)
Read-only
The [Id](-mfax-faxdevice-id-vb.md) is a numeric value that uniquely identifies a fax device.
[PoweredOff](-mfax-faxdevice-poweredoff-vb.md)
Read-only
The [PoweredOff](-mfax-faxdevice-poweredoff-vb.md) property is a Boolean value that indicates whether the fax device is currently available for sending and receiving faxes.
[ProviderUniqueName](-mfax-faxdevice-provideruniquename-vb.md)
Read-only
The [ProviderUniqueName](-mfax-faxdevice-provideruniquename-vb.md) property is a null-terminated string that contains the unique name for the FSP associated with the device.
[ReceiveMode](-mfax-faxdevice-receivemode.md)
Read/write
The [ReceiveMode](-mfax-faxdevice-receivemode.md) property is a value from the [FAX_DEVICE_RECEIVE_MODE_ENUM](/previous-versions/windows/desktop/api/FaxComex/ne-faxcomex-fax_device_receive_mode_enum) enumeration that defines the way a device answers an incoming call. The value assigned to this property indicates whether the device does not answer the call, the device can answer the call manually, or the device answers the call automatically.
[ReceivingNow](-mfax-faxdevice-receivingnow-vb.md)
Read/write
The [ReceivingNow](-mfax-faxdevice-receivingnow-vb.md) 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).
[RingingNow](-mfax-faxdevice-ringingnow-vb.md)
Read-only
The [RingingNow](-mfax-faxdevice-ringingnow-vb.md) 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).
[RingsBeforeAnswer](-mfax-faxdevice-ringsbeforeanswer-vb.md)
Read/write
The [RingsBeforeAnswer](-mfax-faxdevice-ringsbeforeanswer-vb.md) property is a number that specifies the number of rings that occur before the fax device answers an incoming fax call.
[SendEnabled](-mfax-faxdevice-sendenabled-vb.md)
Read/write
The [SendEnabled](-mfax-faxdevice-sendenabled-vb.md) property is a Boolean value that indicates whether the fax device is enabled for sending faxes.
[SendingNow](-mfax-faxdevice-sendingnow-vb.md)
Read-only
The [SendingNow](-mfax-faxdevice-sendingnow-vb.md) 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).
[!Note]
The value of this property is set at the time that the FaxDevice object is created and is refreshed when you call the [Refresh](-mfax-faxdevice-refresh-vb.md) method.

[TSID](-mfax-faxdevice-tsid-vb.md)
Read/write
The [TSID](-mfax-faxdevice-tsid-vb.md) property is a null-terminated string that contains the TSID for the device.
[UsedRoutingMethods](-mfax-faxdevice-usedroutingmethods-vb.md)
Read-only
The [UsedRoutingMethods](-mfax-faxdevice-usedroutingmethods-vb.md) 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](-mfax-faxinboundroutingmethod.md)).

 

Remarks

A FaxDevice object is accessed through a FaxDevices object.

faxserver, faxdevices, and faxdevice objects

Note

Changes made to the FaxDevice object will not be saved until you call the Save method.

 

To create a FaxDevice object in Microsoft Visual Basic, call the Item or get_ItemById property of the FaxDevices object.

To create a FaxDevice object in C++, call the Item or get_ItemById method.

When the properties PoweredOff, ReceivingNow, SendingNow, and RingingNow are all False, then the fax device is active and idle.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Header
Faxcomex.h
DLL
Fxscomex.dll
IID
CLSID_FaxDevice

See also

Fax Service object hierarchy

IFaxDevice