IFaxPort::get_Priority

The IFaxPort::get_Priority method retrieves the Priority property for a FaxPort object. The Priority property is a number representing the transmission priority designated for a specified fax port. Priority determines the relative order in which available fax devices send outgoing transmissions.

Visual Basic Reference

HRESULT get_Priority(
  LONG *pVal  // receives priority for port selection
);

Parameters

pVal

[out] Pointer to a variable that specifies the transmission priority for the specified fax port. Valid values for this property are 1 through n, where n is the value returned by a call to the IFaxPorts::get_Count 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

When the fax server initiates an outgoing fax transmission, it chooses the fax port with the highest priority and send capability. If that port is not available, the server selects the next available port that follows in rank order, and so on. When a client application changes the priority for a fax port, the fax service adjusts the priority for the other fax ports attached to the server. The Priority property has no effect on incoming transmissions.

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, IFaxPort, IFaxPorts, IFaxPort::put_Priority, IFaxPorts::get_Count