Platform SDK: Fax Services

IFaxServer::get_UseDeviceTsid

The IFaxServer::get_UseDeviceTsid method retrieves the UseDeviceTsid property for a FaxServer object. The UseDeviceTsid property is a Boolean value that indicates whether the fax server uses the device's transmitting station identifier (TSID) instead of a user-specified TSID.

Visual Basic Reference

HRESULT get_UseDeviceTsid(
  BOOL *pVal  // receives TSID flag
);

Parameters

pVal
[out] Pointer to a Boolean variable that indicates whether the fax server uses the device's transmitting station identifier (TSID) or a user-specified TSID for outgoing fax transmissions. If this parameter is equal to TRUE, the fax server uses the device's TSID.

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

To ensure that the TSID for a port is associated with outbound faxes, set the UseDeviceTsid property equal to TRUE. This overrides the TSID a user can optionally specify for an outbound fax with a call to the IFaxDoc::put_Tsid method.

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, IFaxServer, IFaxServer::put_UseDeviceTsid, IFaxDoc::put_Tsid