IFaxServer::GetPorts method (faxcom.h)

The 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.

Syntax

HRESULT GetPorts(
  [out] VARIANT *retval
);

Parameters

[out] retval

Type: VARIANT*

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

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

FaxServer

IFaxPort

IFaxPorts

IFaxServer

IUnknown::QueryInterface