FaxStatus (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FaxStatus (Function)

In french: FaxEtat

Returns the status of a fax that was sent by FaxSend. FaxStatus fills the FaxCompleteStatus structure that contains the fax characteristics.

Remark: This function can be used in Windows 2000, XP or later.

Reminder: In Windows Vista (and later), the management of faxes is available with Windows Professional et Windows Integral Edition.

Example

ConnectID is int
ConnectID = FaxConnect()
...
FaxName is string = "MyFax"
FaxID = FaxSend(ConnectID, FaxName, "Message.txt", "0102030405")
...
IF FaxStatus(ConnectID, FaxName) = FaxStatusSent THEN
Info("The fax was sent")
ELSE
Info("Status of the fax: " + FaxCompleteStatus.StatusCaption)
END
...
FaxDisconnect(ConnectID)

Syntax

<Result> = FaxStatus(<Connection identifier> , <Fax name or Fax identifier>)

<Result>: Integer constant

Status of specified fax:
FaxStatusCanceled The fax transmission is canceled.
FaxStatusCall The fax is dialing out.
FaxStatusLocked The recipient number is locked.
FaxStatusDisconnected Disconnection during the transmission.
FaxStatusSend The fax is currently sent.
FaxStatusSent The fax was sent.
FaxStatusError Unable to get the fax status.
FaxStatusFatalError Fatal error.
FaxStatusBadNumber Wrong fax number.
FaxStatusServerPending The device is available.
FaxStatusOffline The device is offline and unavailable.
FaxStatusInactive The fax sending is disabled (pause between two calls for example).
FaxStatusUnavailable The fax is busy (used by another application).
FaxStatusInit The transmission is currently initialized.
FaxStatusBusy The recipient is busy.
FaxStatusNotFaxCall A call other than a fax call (phone call for example) was received by the device.
FaxStatusNoDialTone No dial tone.
FaxStatusHandled The fax is handled and transmitted by the fax manager.
FaxStatusReceiving The device is currently receiving a fax.
FaxStatusAnswered The recipient answered.
FaxStatusDelayed The call is delayed.
FaxStatusRouting The device is currently routing an incoming fax.
FaxStatusNoAnswer The recipient does not answer.
FaxStatusRing The recipient fax is ringing.

<Connection identifier>: Integer

Connection identifier, returned by FaxConnect. This identifier must correspond with the one from the connection used to send the fax.

<Fax name or Fax identifier>: Character string (with quotes)

Corresponds to:
the name used to identify the outgoing fax. This name was defined by FaxSend.
the fax identifier (returned by FaxOutbox ou FaxInbox)

Component: wd260com.dll