FaxStatus object

The FaxStatus object permits a fax client Visual Basic application to retrieve status information for a specific port on a connected fax server. The FaxStatus object has the following method and properties:

• A method to update status information for a fax port.
• Properties to retrieve attributes of a FaxStatus object, such as whether the parent FaxPort is currently sending or receiving a fax transmission. Attributes also include document and transmission data, sender and recipient names, and routing information.

The FaxStatus object should be created only by a FaxPort object.

You can use the FaxStatus object to provide real-time status information about a parent FaxPort object. Some data is available at all times for an active fax port; other data is relative to sending or receiving a fax and is only available at those times.

Members

The FaxStatus object has these types of members:

• Methods
• Properties

Methods

The FaxStatus object has these methods.

Method	Description
Refresh	The Refresh method updates FaxStatus object information for the associated parent FaxPort object.

 

Properties

The FaxStatus object has these properties.

Property	Access type	Description
Address	Read-only	Retrieves the Address property for the FaxStatus object of a parent FaxPort object. The Address property is a null-terminated string that contains the destination of a fax job.
CallerId	Read-only	Retrieves the CallerId property for the FaxStatus object of a parent FaxPort object. The CallerId property is a string that identifies the calling device that sent an inbound fax job.
Csid	Read-only	Retrieves the Csid property for the FaxStatus object of a parent FaxPort object. The Csid property is a string that contains CSID information, typically the fax number of the receiving device.
CurrentPage	Read-only	Retrieves the CurrentPage property for the FaxStatus object of a parent FaxPort object. The CurrentPage property is a number that identifies the current page of an active outbound fax job on a specific port.
Description	Read-only	Retrieves the Description property for the FaxStatus object of a parent FaxPort object. The Description property is a null-terminated string that describes the current status of the specified port.
DeviceId	Read-only	Retrieves the DeviceId property for the FaxStatus object of a parent FaxPort object. The DeviceId property is a number representing the permanent line identifier for the fax port.
DeviceName	Read-only	Retrieves the DeviceName property for the FaxStatus object of a parent FaxPort object. The DeviceName property is a null-terminated string that contains the user-friendly display name for the fax port.
DocumentName	Read-only	Retrieves the DocumentName property for the FaxStatus object of a parent FaxPort object. The DocumentName property is a null-terminated string that contains the user-friendly name associated with an active fax document.
DocumentSize	Read-only	Retrieves the DocumentSize property for the FaxStatus object of a parent FaxPort object. The DocumentSize property is the size of the fax document associated with the active outbound job on a specific port.
ElapsedTime	Read-only	Retrieves the ElapsedTime property for the FaxStatus object of a parent FaxPort object. The ElapsedTime property is a number that represents the elapsed time for an active fax job.
PageCount	Read-only	Retrieves the PageCount property for the FaxStatus object of a parent FaxPort object. The PageCount property represents the total number of pages in an outbound fax transmission.
Receive	Read-only	Retrieves the Receive property for the FaxStatus object of a parent FaxPort object. The Receive property is a Boolean value that indicates whether a specified fax port is currently receiving a fax.
RecipientName	Read-only	Retrieves the RecipientName property for a FaxStatus object. The RecipientName property is a null-terminated string that contains the name of the recipient of an inbound fax transmission.
RoutingString	Read-only	Retrieves the RoutingString property for the FaxStatus object of a parent FaxPort object. The RoutingString property is a null-terminated string that contains routing information for inbound fax transmissions that is specific to a fax service provider.
Send	Read-only	Retrieves the Send property for the FaxStatus object of a parent FaxPort object. The Send property is a Boolean value that indicates whether a specified fax port is currently sending a fax.
SenderName	Read-only	Retrieves the SenderName property for the FaxStatus object of a parent FaxPort object. The SenderName property is a null-terminated string that contains the name of the user who sent the fax transmission.
StartTime	Read-only	Retrieves the StartTime property for the FaxStatus object of a parent FaxPort object. The StartTime property is a number that represents the starting time for an active fax job.
SubmittedTime	Read-only	Retrieves the SubmittedTime property for the FaxStatus object of a parent FaxPort object. The SubmittedTime property is a number that represents the time the user submitted the active fax job.
Tsid	Read-only	Retrieves the Tsid property for the FaxStatus object of a parent FaxPort object. The Tsid property is a null-terminated string that contains the TSID associated with the fax port.

 

Remarks

When to Implement

You should not implement this class. The Microsoft standard implementation provides complete functionality. You can use the Visual Basic Object Browser to view the FaxStatus object's type library information in Visual Basic syntax.

To create a FaxStatus object

1. Call the Visual Basic CreateObject function to create a FaxServer object.
2. Call the GetPorts method of the FaxServer object to create a FaxPorts object for the connected fax server.
3. Retrieve the Count property and then the Item property for the FaxPorts collection to create a FaxPort object.
4. Call the GetStatus method of the FaxPort object to create a FaxStatus object.

Requirements

Header	Faxcom.h