IFaxStatus::get_SenderName

The IFaxStatus::get_SenderName method retrieves the SenderName property for the FaxStatus object of a parent FaxPort object. The SenderName property is a null-terminated string that contains the name of the user who sent the fax transmission.

Visual Basic Reference

HRESULT get_SenderName(
  BSTR *pVal  // receives fax sender's name
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the name of the sender who queued the outbound fax job. Note that the SenderName property is valid only if the Send property is equal to TRUE.

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 sender's name is not available, the IFaxStatus::get_SenderName method returns an empty string.

The IFaxStatus::get_SenderName 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_Send, IFaxPorts, IFaxPort, SysFreeString