IFaxStatus::get_Receive

The IFaxStatus::get_Receive method retrieves the Receive property for the FaxStatus object of a parent FaxPort object. The Receive property is a Boolean value that indicates whether a specified fax port is currently receiving a fax.

Visual Basic Reference

HRESULT get_Receive(
  BOOL *pVal  // currently receiving fax flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax port is receiving a fax transmission. If this parameter is equal to TRUE, the port is currently receiving a fax.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

To determine if a specified port is currently sending a fax, you can call the IFaxStatus::get_Send method.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxStatus, IFaxStatus::get_Send, IFaxPorts, IFaxPort