IFaxStatus::get_PageCount

The IFaxStatus::get_PageCount method retrieves the PageCount property for the FaxStatus object of a parent FaxPort object. The PageCount property represents the total number of pages in an outbound fax transmission.

Visual Basic Reference

HRESULT get_PageCount(
  LONG *pVal  // receives total page count
);

Parameters

pVal

[out] Pointer to a numeric value that is the total page count for an outbound fax job on the specified port.

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 page count is not available, the IFaxStatus::get_PageCount method returns zero.

You can use the PageCount property of a FaxStatus object in conjunction with the CurrentPage 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_CurrentPage, IFaxPorts, IFaxPort