IFaxStatus interface (faxcom.h)
The FaxStatus dual interface is used by a fax client application to retrieve status information for a specific port on a connected fax server. The IFaxStatus interface includes the following interface methods:
- A method to update status information for a fax port.
- Property methods 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 only be created 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.
Inheritance
The IFaxStatus interface inherits from the IDispatch interface. IFaxStatus also has these types of members:
Methods
The IFaxStatus interface has these methods.
| IFaxStatus::get_Address 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. |
| IFaxStatus::get_CallerId 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. |
| IFaxStatus::get_Csid Retrieves the Csid property for the FaxStatus object of a parent FaxPort object. The Csid property is a string that contains called station identifier (CSID) information, typically the fax number of the receiving device. |
| IFaxStatus::get_CurrentPage 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. |
| IFaxStatus::get_Description 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. |
| IFaxStatus::get_DeviceId 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. |
| IFaxStatus::get_DeviceName 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. |
| IFaxStatus::get_DocumentName 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. |
| IFaxStatus::get_DocumentSize 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. |
| IFaxStatus::get_ElapsedTime 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. |
| IFaxStatus::get_PageCount 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. |
| IFaxStatus::get_Receive 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. |
| IFaxStatus::get_RecipientName 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. |
| IFaxStatus::get_RoutingString 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. |
| IFaxStatus::get_Send 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. |
| IFaxStatus::get_SenderName 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. |
| IFaxStatus::get_StartTime 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. |
| IFaxStatus::get_SubmittedTime 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. |
| IFaxStatus::get_Tsid Retrieves the Tsid property for the FaxStatus object of a parent FaxPort object. The Tsid property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port. |
| IFaxStatus::Refresh The Refresh method updates FaxStatus object information for the associated parent FaxPort object. |
Remarks
When to Implement
You should not implement this interface. The Microsoft standard implementation provides complete functionality.When to Use
Use the IFaxStatus interface to update the status information for a specific fax port, and to retrieve the properties of a FaxStatus object.A client application should not call the CoCreateInstance function to retrieve an IFaxStatus interface pointer. Instead, the application must perform the following steps to create an instance of a FaxStatus object:
- Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
- Call the IFaxServer::Connect method to connect to an active fax server.
- Call the IFaxServer::GetPorts method to create and initialize a FaxPorts object for the connected fax server.
- Call the IFaxPorts::get_Count method and then the IFaxPorts::get_Item method to retrieve IDispatch interface pointers for each child FaxPort object. (You can also call the IUnknown::QueryInterface method to retrieve an IFaxPort interface pointer.)
- Use the IDispatch interface pointer to call the IFaxPort::GetStatus interface method, to retrieve an IDispatch interface pointer to a FaxStatus object.
- Use the IDispatch interface pointer to call IFaxStatus interface methods.
- Call the IFaxServer::Disconnect method to disconnect from the fax server.
- Call the IUnknown::Release method for each FaxStatus object to allow the object to deallocate itself. Also call IUnknown::Release once for each FaxPort object, and again to destroy both the IFaxPorts and the parent IFaxServer interface pointers.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | faxcom.h |
See also
Fax Service Client API Interfaces