IFaxStatus::get_DeviceId

The IFaxStatus::get_DeviceId method retrieves the DeviceId property for the FaxStatus object of a parent FaxPort object. The DeviceId property is a number representing the permanent line identifier for the fax port.

Visual Basic Reference

HRESULT get_DeviceId(
  LONG *pVal  // receives numeric line identifier
);

Parameters

pVal

[out] Pointer to a numeric value that is the permanent line identifier for the fax port.

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

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, and thereby associate a FaxStatus object with a FaxPort object.

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, IFaxPorts, IFaxPort