IFaxServer::GetJobs

The IFaxServer::GetJobs method creates and initializes a FaxJobs object for a specified FaxServer object. The FaxJobs object allows enumeration of the current queued jobs for the connected fax server.

Visual Basic Reference

HRESULT GetJobs(
  VARIANT *retVal  // receives IDispatch pointer to FaxJobs object
);

Parameters

retVal

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

The IFaxServer::GetJobs method retrieves an IDispatch interface pointer to a FaxJobs collection. A fax client application can also access the IFaxJobs 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 IFaxJobs interface pointer because it will not be instantiated correctly.

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, IFaxServer, IFaxJob, IFaxJobs, IUnknown::QueryInterface