IFaxRoutingMethod::get_Enable

The IFaxRoutingMethod::get_Enable method retrieves the Enable property for a FaxRoutingMethod object. The Enable property is a Boolean value that indicates whether a fax routing method is enabled on a particular fax port.

Visual Basic Reference

HRESULT get_Enable(
  BOOL *pVal  // receives enable/disable flag for fax routing method
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax routing method is enabled or disabled for the parent fax port. If this parameter is equal to TRUE, the routing method 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

If a fax client application passes a value of TRUE to the IFaxRoutingMethod::put_Enable method, the method enables the routing method for inbound faxes on the parent port.

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, IFaxRoutingMethod, IFaxRoutingMethods, IFaxRoutingMethod::put_Enable, IFaxPort::CanModify