IFaxDevices::get_Item method (faxcomex.h)

Article
02/22/2024

The IFaxDevices::get_Item method returns a FaxDevice object from the FaxDevices collection, using its index.

Syntax

HRESULT get_Item(
  [in]  VARIANT    vIndex,
  [out] IFaxDevice **pFaxDevice
);

Parameters

[in] vIndex

Type: VARIANT

VARIANT that specifies the index of the item to retrieve from the fax device collection. If this parameter is type VT_I2 or VT_I4, the parameter specifies the index of the item to retrieve from the collection. Valid values for the index are in the range from 1 to n, where n is the number of devices returned by a call to the IFaxDevices::get_Count method. If this parameter is type VT_BSTR, the parameter is a string containing the unique name of the fax device to retrieve. Other types are not supported.

[out] pFaxDevice

Type: IFaxDevice**

Receives the address of a pointer to a FaxDevice object.

Return value

Type: HRESULT

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

Remarks

To retrieve an item from the FaxDevices collection using the device ID, call the IFaxDevices::get_ItemById property.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	faxcomex.h
DLL	Fxscomex.dll

Share via