Platform SDK: Fax Services

IFaxPort

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:

Note  A fax client application can call the IFaxPort::get_CanModify method before calling any method that begins with IFaxPort::put_ to ensure that the client has access to modify the specified fax port.

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:

  1. Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
  2. Call the IFaxServer::Connect method to connect to an active fax server.
  3. Call the IFaxServer::GetPorts method to create and initialize a FaxPorts object for the connected fax server.
  4. 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.)
  5. Use the IDispatch interface pointer to call IFaxPort interface methods.
  6. Call the IFaxServer::Disconnect method to disconnect from the fax server.
  7. Call the IUnknown::Release method for each FaxPort object to allow the object to deallocate itself, and again to destroy the IFaxPorts interface pointer.

The property methods of the IFaxPort interface retrieve or set the properties described following. If the property supports read access, the IFaxPort interface includes a get_PropertyName method. If the property supports write access, the interface includes a put_PropertyName method.

Following are the properties associated with a FaxPort object. You can find a complete list of IFaxPort interface methods in Vtable order following the list of properties.

Property Type Access Description
CanModify BOOL R Flag that indicates whether the user has access to modify configuration information for the fax port.
Csid BSTR R/W Called station identifier (CSID) associated with the fax port.
DeviceId LONG R Permanent line identifier of the fax port.
Name BSTR R User-friendly display name for the fax port.
Priority LONG R/W Transmission priority of the specified fax port. Priority determines the relative order in which available fax devices send outgoing transmissions.
Receive BOOL R/W Flag that indicates whether a fax port is enabled to receive faxes.
Rings LONG R/W Number of rings an incoming fax call should wait before the fax port answers the call.
Send BOOL R/W Flag that indicates whether a fax port is enabled to send faxes.
Tsid BSTR R/W Transmitting station identifier (TSID) associated with the specified fax port.

Methods in Vtable Order

IUnknown Methods

IDispatch Methods

IFaxPort Methods

Method Description
get_Name Retrieves the user-friendly name for the fax port.
get_DeviceId Retrieves the permanent line identifier for the fax port.
get_Rings
put_Rings		 Retrieves or sets a new value for the number of rings an incoming fax call should wait before the fax port answers the call.
get_Csid
put_Csid		 Retrieves or sets a new value for the called station identifier (CSID) associated with the fax port.
get_Tsid
put_Tsid		 Retrieves or sets a new value for the transmitting station identifier (TSID) associated with the fax port.
get_Send
put_Send		 Retrieves or sets a new value for the flag that indicates whether the fax port is enabled to send faxes.
get_Receive
put_Receive		 Retrieves or sets a new value for the flag that indicates whether the fax port is enabled to receive faxes.
get_Priority
put_Priority		 Retrieves or sets a new value for the transmission priority for the fax port. Priority determines the relative order in which available fax devices send outgoing transmissions.
GetRoutingMethods Creates a FaxRoutingMethods object for the fax port.
get_CanModify Retrieves a value that indicates whether the user has permission to modify information for the fax port.
GetStatus Creates a FaxStatus object for the fax port.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces

Built on Wednesday, February 09, 2000