IFaxStatus::get_CurrentPage

The IFaxStatus::get_CurrentPage method retrieves the CurrentPage property for the FaxStatus object of a parent FaxPort object. The CurrentPage property is a number that identifies the current page of an active outbound fax job on a specific port.

Visual Basic Reference

HRESULT get_CurrentPage(
  LONG *pVal  // receives current page number
);

Parameters

pVal

[out] Pointer to a numeric value that is the page in the fax transmission that the port is currently sending. The page number is relative to 1. This parameter has no meaning for an inbound job.

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

If the current page is not available, the IFaxStatus::get_CurrentPage method returns zero.

You can use the CurrentPage property of a FaxStatus object in conjunction with the PageCount property of the object to provide users with a running page count for an outbound fax job. For example, you could inform a user that the fax server is currently transmitting the second page of a four page transmission.

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, IFaxStatus, IFaxStatus::get_PageCount, IFaxPorts, IFaxPort