IFaxPorts::get_Item method (faxcom.h)

Article
02/22/2024

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.

Syntax

HRESULT get_Item(
  [in]  long    Index,
  [out] VARIANT *pVal
);

Parameters

[in] Index

Type: LONG

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.

[out] pVal

Type: VARIANT*

Receives a 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 value

Type: HRESULT

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

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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	faxcom.h
DLL	Faxcom.dll