Platform SDK: Fax Services

FaxPort Object (Visual Basic)

The FaxPort object permits a fax client 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.

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.

Following is a list of the Visual Basic methods of FaxPort objects.

Method	Visual Basic Example
GetRoutingMethods
Creates a FaxRoutingMethods object for the fax port.	Dim FRM As Object Dim FP As Object FRM = FP.GetRoutingMethods()
GetStatus
Creates a FaxStatus object for the fax port.	Dim FS As Object Dim FP As Object FS = FP.GetStatus()

Following is a list of the Visual Basic properties of FaxPort objects.

Property	Visual Basic Example
CanModify LONG Read-only
Flag that indicates whether the user has access to modify configuration information for the fax port. A nonzero value indicates that the user can modify the configuration for the fax port.	Dim lCanModify As Long lCanModify = objFaxPort.CanModify
Csid STRING Read/Write
Called station identifier (CSID) associated with the fax port.	' Retrieve Dim strCsid As String strCsid = objFaxPort.Csid ' Assign objFaxPort.Csid = "MyCsid"
DeviceId LONG Read-only
Permanent line identifier of the fax port.	Dim lDeviceId As Long lDeviceId = objFaxPort.DeviceId
Name STRING Read-only
User-friendly display name for the fax port.	Dim strName As String strName = objFaxPort.Name
Priority LONG Read/Write
Transmission priority of the specified fax port. Priority determines the relative order in which available fax devices send outgoing transmissions. Valid values for this property are 1 through n, where n is the value returned by a call to the Count property.	' Retrieve Dim lPriority As Long lPriority = objFaxPort.Priority ' Assign objFaxPort.Priority = 2
Receive LONG Read/Write
Flag that indicates whether a fax port is enabled to receive faxes. If this property is a nonzero value, the port is enabled to receive faxes.	' Retrieve Dim lReceive As Long lReceive = objFaxPort.Receive ' Assign objFaxPort.Receive = – 1
Rings LONG Read/Write
Number of rings an incoming fax call should wait before the fax port answers the call. Valid values for this property are 1 through 99.	' Retrieve Dim lRings As Long lRings = objFaxPort.Rings ' Assign objFaxPort.Rings = 4
Send LONG Read/Write
Flag that indicates whether a fax port is enabled to send faxes. If this property is a nonzero value, the port is enabled to send faxes.	' Retrieve Dim lSend As Long lSend = objFaxPort.Send ' Assign objFaxPort.Send = – 1
Tsid STRING Read/Write
Transmitting station identifier (TSID) associated with the specified fax port.	' Retrieve Dim strTsid As String strTsid = objFaxPort.Tsid ' Assign objFaxPort.Tsid = "MyTsid"