IFaxServer::GetJobs method (faxcom.h)

The 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.

Syntax

HRESULT GetJobs(
  [out] VARIANT *retval
);

Parameters

[out] retval

Type: VARIANT*

Pointer to a VARIANT structure that receives an IDispatch interface pointer to a FaxJobs object. The method returns a pdispVal 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

The IFaxServer::GetJobs method retrieves an IDispatch interface pointer to a FaxJobs object. 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

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

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

FaxServer

IFaxJob

IFaxJobs

IFaxServer

IUnknown::QueryInterface