FaxPort object
The FaxPort object permits a fax client Microsoft Visual Basic application to access configuration information for a fax port on a connected fax server. Information includes, among other items, a device identifier, the port's name and current status, and station identifiers. There is one FaxPort object for each port associated with the server.
The FaxPort object has the following methods and properties:
- Methods to create FaxRoutingMethods objects and FaxStatus objects.
- Properties to set and retrieve individual attributes associated with a FaxPort object.
Before attempting to change port configuration information, a fax client application can retrieve the CanModify property for a FaxPort object to ensure that the client has access to modify the specified fax port.
Members
The FaxPort object has these types of members:
Methods
The FaxPort object has these methods.
| Method | Description |
|---|---|
| GetRoutingMethods | The GetRoutingMethods interface method creates a FaxRoutingMethods object for the parent FaxPort object. The FaxRoutingMethods object allows enumeration of the fax routing methods associated with a fax port. Fax routing methods are defined by a fax routing extension DLL. |
| GetStatus | The GetStatus method creates a FaxStatus object for the parent FaxPort object. The FaxStatus object contains the current status of a fax port. |
Properties
The FaxPort object has these properties.
| Property | Access type | Description |
|---|---|---|
| CanModify |
Read-only |
The CanModify property is a Boolean value that indicates whether the user has permission to modify configuration information for the fax port. |
| Csid |
Read/write |
The Csid property is a null-terminated string that contains the CSID associated with the fax port. |
| DeviceId |
Read-only |
The DeviceId property is a number representing the permanent line identifier for the fax port. |
| Name |
Read-only |
The Name property is a null-terminated string that contains the user-friendly display name for a fax port. |
| Priority |
Read/write |
The 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. |
| Receive |
Read/write |
The Receive property is a Boolean value that indicates whether a specified fax port is enabled to receive faxes. |
| Rings |
Read/write |
The Rings property represents the number of rings an incoming fax call should wait before the fax port answers the call. |
| Send |
Read/write |
The Send property is a Boolean value that indicates whether a fax port is enabled to send faxes. |
| Tsid |
Read/write |
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 FaxPort object's type library information in Visual Basic syntax.
To create a FaxPort object
- Call the Visual Basic CreateObject function to create a FaxServer object.
- Call the GetPorts method of the FaxServer object to create a FaxPorts object on the connected fax server.
- Retrieve the Count property and then the Item property for the FaxPorts collection to create a FaxPort object.
Requirements
| Header |
|