IFaxStatus::get_DocumentSize

The IFaxStatus::get_DocumentSize method retrieves the DocumentSize property for the FaxStatus object of a parent FaxPort object. The DocumentSize property is the size of the fax document associated with the active outbound job on a specific port.

Visual Basic Reference

HRESULT get_DocumentSize(
  LONG *pVal  // receives outbound fax document size
);

Parameters

pVal

[out] Pointer to a numeric value that is the size, in bytes, of an active outbound fax document.

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

You can use the DocumentSize property of a FaxStatus object in conjunction with the DocumentName property of the object to inform users about the size of outbound jobs.

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_DocumentName, IFaxPorts, IFaxPort