FaxStatus Object (Visual Basic)

The FaxStatus object permits a fax client Visual Basic application to retrieve status information for a specific port on a connected fax server. The FaxStatus object has the following method and properties:

• A method to update status information for a fax port.
• Properties 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 be created only 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.

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 FaxStatus object's type library information in Visual Basic syntax.

To create a FaxStatus object

1. Call the Visual Basic CreateObject function to create a FaxServer object.
2. Call the GetPorts method of the FaxServer object to create a FaxPorts object for the connected fax server.
3. Retrieve the Count property and then the Item property for the FaxPorts collection to create a FaxPort object.
4. Call the GetStatus method of the FaxPort object to create a FaxStatus object.

The following is a Visual Basic method of FaxStatus objects.

Dim FS As Object
FS.Refresh()

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

Dim strAddress As String
strAddress = objFaxStatus.Address

Dim strCallerId As String
strCallerId = objFaxStatus.CallerId

Dim strCsid As String
strCsid = objFaxStatus.Csid

Dim lCurrPage As Long
lCurrPage = objFaxStatus.CurrentPage

Dim strDescrip As String
strDescrip = objFaxStatus.Description

Dim lDeviceId As Long
lDeviceId = objFaxStatus.DeviceId

Dim strDevName As String
strDevName = objFaxStatus.DeviceName

Dim strDocName As String
strDocName = objFaxStatus.DocumentName

Dim lDocSize As Long
lDocSize = objFaxStatus.DocumentSize

Dim dElapsedTime As Date
dElapsedTime = objFaxStatus.ElapsedTime

Dim lPageCount As Long
lPageCount = objFaxStatus.PageCount

Dim lReceive As Long
lReceive = objFaxStatus.Receive

Dim str RecName As String
strRecName = objFaxStatus.RecipientName

Dim strRoutString As String
strRoutString = objFaxStatus.RoutingString

Dim lSend As Long
lSend = objFaxStatus.Send

Dim strSenderName As String
strSenderName = objFaxStatus.SenderName

Dim dStart As Date
dStart = objFaxStatus.StartTime

Dim dSubmitted As Date
dSubmitted = objFaxStatus.SubmittedTime

Dim strTsid As String
strTsid = objFaxStatus.Tsid