IFaxDoc::put_Tsid

The IFaxDoc::put_Tsid method changes the Tsid property of a FaxDoc object. The Tsid property is a null-terminated string that contains a user-defined transmitting station identifier (TSID).

Visual Basic Reference

HRESULT put_Tsid(
  BSTR newVal  // new value for transmitting station identifier
);

Parameters

newVal

[in] Specifies the new user-defined value to assign to the Tsid property. The TSID is typically the fax number of the device sending the fax transmission. For more information, see the following Remarks section.

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

If the fax server allows user-defined TSID strings, the service will transmit the value of the newVal parameter to the receiving fax device instead of the TSID associated with the sending device. You can call the IFaxServer::get_UseDeviceTsid method to determine if the fax server is configured to permit user-specified TSIDs.

To ensure that the TSID for a port is associated with outbound faxes, call the IFaxServer::put_UseDeviceTsid method and set the UseDeviceTsid property equal to TRUE. The port TSID will override the TSID a user can specify for an outbound fax with a call to the IFaxDoc::put_Tsid method.

Note that the T.30 specification of the International Telecommunication Union (ITU) restricts the value of a TSID to 20 ASCII characters. If a fax client application specifies a TSID that contains non-ASCII characters, the fax service removes them. If the TSID exceeds 20 characters, the service truncates the extra characters.

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