Platform SDK: Fax Services

IFaxJobs::get_Item

The IFaxJobs::get_Item method creates a FaxJob object for a specified fax job. The object allows enumeration of the fax jobs associated with a connected fax server.

Visual Basic Reference

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

Parameters

Index
[in] Specifies a LONG variable that indicates the fax job to retrieve. Valid values for this parameter are in the range from 1 to n, where n is the number of FaxJob objects returned by a call to the IFaxJobs::get_Count method.
pVal
[out] Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxJob 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 IFaxJob interface directly by calling the IUnknown::QueryInterface method to retrieve an IFaxJob 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, IFaxJobs, IFaxJobs::get_Count, IFaxJob, IFaxServer::GetJobs, IUnknown::QueryInterface