IFaxPort::get_Receive

The IFaxPort::get_Receive method retrieves the Receive property for a FaxPort object. The Receive property is a Boolean value that indicates whether a specified fax port is enabled to receive faxes.

Visual Basic Reference

HRESULT get_Receive(
  BOOL *pVal  // receives enabled/disabled receive flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether receiving faxes is enabled or disabled for the fax port. If this parameter is equal to TRUE, receiving faxes is enabled for the port.

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

The IFaxPort::get_Receive method returns a value of TRUE if the fax port is enabled to receive faxes. To enable a fax port to receive faxes, a fax client application must pass a value of TRUE to the IFaxPort::put_Receive 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, IFaxPort, IFaxPorts, IFaxPort::put_Receive