IFaxJob::get_DisplayName

The IFaxJob::get_DisplayName method retrieves the DisplayName property for a FaxJob object. The DisplayName property is a null-terminated string that contains the user-friendly name to associate with the fax job.

Visual Basic Reference

HRESULT get_DisplayName(
  BSTR *pVal  // receives display name
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the user-friendly name to associate with the fax job. This is the name that appears in the job queue.

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 JobId property to uniquely identify a fax job because it is possible for multiple fax jobs to have the same DisplayName property.

The IFaxJob::get_DisplayName 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, IFaxJob, IFaxJobs, SysFreeString, IFaxJob::get_JobId