Edit

Share via

_IFaxServerNotify2::OnDeviceStatusChange method (faxcomex.h)

  • Article

The fax service calls the IFaxServerNotify2::OnDeviceStatusChange method when there is a change to a fax device status.

Syntax

HRESULT OnDeviceStatusChange(
  IFaxServer2  *pFaxServer,
  long         lDeviceId,
  VARIANT_BOOL bPoweredOff,
  VARIANT_BOOL bSending,
  VARIANT_BOOL bReceiving,
  VARIANT_BOOL bRinging
);

Parameters

pFaxServer

Type: IFaxServer2*

A IFaxServer2 object.

lDeviceId

Type: long

Long value that contains the ID of the device for which the status has changed.

bPoweredOff

Type: VARIANT_BOOL

Boolean value. If this parameter is equal to TRUE, the fax device is currently offline and unavailable for sending and receiving faxes. If this parameter is equal to FALSE, the fax device is online and available.

bSending

Type: VARIANT_BOOL

Boolean value. If this parameter is equal to TRUE, the fax device is sending faxes. If this parameter is equal to FALSE, the fax device is not sending faxes.

bReceiving

Type: VARIANT_BOOL

Boolean value. If this parameter is equal to TRUE, the fax device is receiving faxes. If this parameter is equal to FALSE, the fax device is not receiving faxes.

bRinging

Type: VARIANT_BOOL

Boolean value. If this parameter is equal to TRUE, the fax device is ringing. If this parameter is equal to FALSE, the fax device is not ringing.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

To implement this functionality in Visual Basic, select and implement the appropriate event procedure. For an example, see Registering for Fax Events.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header faxcomex.h
DLL Fxscomex.dll

See also

IFaxServerNotify2