IFaxStatus::get_DocumentName

The IFaxStatus::get_DocumentName method retrieves the DocumentName property for the FaxStatus object of a parent FaxPort object. The DocumentName property is a null-terminated string that contains the user-friendly name associated with an active fax document.

Visual Basic Reference

HRESULT get_DocumentName(
  BSTR *pVal  // receives user-friendly fax document name
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the name of the fax document associated with the active outbound job on the specific fax port. The string is suitable for display to the user. The DocumentName property only has meaning for outbound transmissions.

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 DocumentName property of a FaxStatus object in conjunction with the DocumentSize property of the object to inform users about the size of outbound jobs.

The IFaxStatus::get_DocumentName method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

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_DocumentSize, IFaxPorts, IFaxPort, SysFreeString