IFaxStatus::get_DeviceName method (faxcom.h)

Retrieves the DeviceName property for the FaxStatus object of a parent FaxPort object. The DeviceName property is a null-terminated string that contains the user-friendly display name for the fax port.

This property is read-only.

Syntax

HRESULT get_DeviceName(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

Note that it is possible for multiple fax ports to have the same user-friendly name. You can use the DeviceId property of a FaxStatus object to uniquely identify a fax port, and associate a FaxStatus object with a FaxPort object.

The IFaxStatus::get_DeviceName 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

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header faxcom.h
DLL Faxcom.dll

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IFaxPort

IFaxPorts

IFaxStatus

IFaxStatus::get_DeviceId

SysFreeString