IFaxPort interface (faxcom.h)
The IFaxPort dual interface is used by a fax client application to access configuration information for a fax port on a connected fax server. The IFaxPort interface includes the following methods.
- Methods to create FaxRoutingMethods objects and FaxStatus objects.
- Property methods to set and retrieve individual property values associated with a FaxPort object retrieved by the IFaxPorts interface. A FaxPorts object is a collection of FaxPort objects.
Inheritance
The IFaxPort interface inherits from the IDispatch interface. IFaxPort also has these types of members:
Methods
The IFaxPort interface has these methods.
IFaxPort::get_CanModify The IFaxPort::get_CanModify property is a Boolean value that indicates whether the user has permission to modify configuration information for the fax port. |
IFaxPort::get_Csid The IFaxPort::get_Csid property is a null-terminated string that contains the called station identifier (CSID) associated with the fax port. (Get) |
IFaxPort::get_DeviceId The IFaxPort::get_DeviceId property is a number representing the permanent line identifier for the fax port. |
IFaxPort::get_Name The IFaxPort::get_Name property is a null-terminated string that contains the user-friendly display name for a fax port. |
IFaxPort::get_Priority The IFaxPort::get_Priority property is a number representing the transmission priority designated for a specified fax port. Priority determines the relative order in which available fax devices send outgoing transmissions. (Get) |
IFaxPort::get_Receive The IFaxPort::get_Receive property is a Boolean value that indicates whether a specified fax port is enabled to receive faxes. (Get) |
IFaxPort::get_Rings The IFaxPort::get_Rings property represents the number of rings an incoming fax call should wait before the fax port answers the call. (Get) |
IFaxPort::get_Send The IFaxPort::get_Send property is a Boolean value that indicates whether a fax port is enabled to send faxes. (Get) |
IFaxPort::get_Tsid The IFaxPort::get_Tsid property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port. (Get) |
IFaxPort::GetRoutingMethods The IFaxPort::GetRoutingMethods interface method creates a FaxRoutingMethods object for the parent FaxPort object. |
IFaxPort::GetStatus The IFaxPort::GetStatus method creates a FaxStatus object for the parent FaxPort object. The FaxStatus object contains the current status of a fax port. |
IFaxPort::put_Csid The IFaxPort::get_Csid property is a null-terminated string that contains the called station identifier (CSID) associated with the fax port. (Put) |
IFaxPort::put_Priority The IFaxPort::get_Priority property is a number representing the transmission priority designated for a specified fax port. Priority determines the relative order in which available fax devices send outgoing transmissions. (Put) |
IFaxPort::put_Receive The IFaxPort::get_Receive property is a Boolean value that indicates whether a specified fax port is enabled to receive faxes. (Put) |
IFaxPort::put_Rings The IFaxPort::get_Rings property represents the number of rings an incoming fax call should wait before the fax port answers the call. (Put) |
IFaxPort::put_Send The IFaxPort::get_Send property is a Boolean value that indicates whether a fax port is enabled to send faxes. (Put) |
IFaxPort::put_Tsid The IFaxPort::get_Tsid property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port. (Put) |
Remarks
When to Implement
You should not implement this interface. The Microsoft standard implementation provides complete functionality.When to Use
Use the IFaxPort interface to retrieve and set the properties of a FaxPort object.A client application should not call the CoCreateInstance function to retrieve an IFaxPort interface pointer. Instead, the application must perform the following steps to create an instance of a FaxPort 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 IFaxPort interface methods.
- Call the IFaxServer::Disconnect method to disconnect from the fax server.
- Call the IUnknown::Release method for each FaxPort object to allow the object to deallocate itself, and again to destroy the IFaxPorts interface pointer.
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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for