IFaxJob::get_UserName

The IFaxJob::get_UserName method retrieves the UserName property for a FaxJob object. The UserName property is a null-terminated string that contains the name of the user who submitted the fax job to the job queue. The UserName property applies only to outgoing fax transmissions.

Visual Basic Reference

HRESULT get_UserName(
  BSTR *pVal  // receives user name
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the name of the account that queued the fax 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

You can call the IFaxJob::get_SenderName method to retrieve the name of the person who initiated the fax job.

The IFaxJob::get_UserName 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_SenderName