IFaxPort::get_Send

The IFaxPort::get_Send method retrieves the Send property for a FaxPort object. The Send property is a Boolean value that indicates whether a fax port is enabled to send faxes.

Visual Basic Reference

HRESULT get_Send(
  BOOL *pVal  // receives send enabled/disabled flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether sending faxes is enabled or disabled for the fax port. To enable a fax port to send faxes, a fax client application must pass a value of TRUE to the IFaxPort::put_Send method.

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_Send method returns a value of TRUE if the fax port is enabled to send faxes. If a fax client application passes a value of TRUE to the IFaxPort::put_Send method, that method enables the fax port to send faxes.

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_Send