IFaxRoutingMethod::get_DeviceName

The IFaxRoutingMethod::get_DeviceName method retrieves the DeviceName property for a FaxPort object. The DeviceName property is a null-terminated string that contains the user-friendly display name for a fax port.

Visual Basic Reference

HRESULT get_DeviceName(
  BSTR *pVal  // receives user-friendly display name for port
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the user-friendly name for the fax port associated with the specified fax routing method.

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

Note that it is possible for multiple fax ports to have the same user-friendly name. You can use the DeviceId property to uniquely identify a fax port.

The IFaxRoutingMethod::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

  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, IFaxRoutingMethod, IFaxRoutingMethods, IFaxRoutingMethod::get_DeviceId, IFaxPort, IFaxPorts, SysFreeString