IFaxPorts::get_Item

The IFaxPorts::get_Item method creates a FaxPort object for a specified fax port. The object allows enumeration of port configuration information for a specific connection to a fax server.

Visual Basic Reference

HRESULT get_Item(
  LONG Index,    // index of the fax port
  VARIANT *pVal  // receives IDispatch pointer to a FaxPort object
);

Parameters

Index

[in] Specifies a LONG variable that indicates the fax port to retrieve. Valid values for this parameter are in the range from 1 to n, where n is the number of fax ports returned by a call to the IFaxPorts::get_Count method.

pVal

[out] Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxPort 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

A fax client application can also access the IFaxPort interface directly by calling the IUnknown::QueryInterface method to retrieve an IFaxPort interface pointer.

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