IFaxServer::GetPorts

The IFaxServer::GetPorts method creates and initializes a FaxPorts object for a specified FaxServer object. The FaxPorts object allows enumeration of fax port configuration information for the connected fax server.

Visual Basic Reference

HRESULT GetPorts(
  VARIANT *retVal  // receives IDispatch pointer to FaxPorts object
);

Parameters

retVal

[out] Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxPorts object. The method returns a ppdispVal member with a VT_DISPATCH data type.

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 IFaxServer::GetPorts method retrieves an IDispatch interface pointer to a FaxPorts object. A fax client application can also access the IFaxPorts interface directly by calling the IUnknown::QueryInterface method to retrieve an interface pointer.

A fax client application should not call the CoCreateInstance function to retrieve an IFaxPorts interface pointer because it will not be instantiated correctly.

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, IFaxServer, IFaxPorts, IFaxPort, IUnknown::QueryInterface