Platform SDK: Fax Services |
The IFaxPort::put_Tsid method changes the Tsid property for a FaxPort object. The Tsid property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port.
Before calling this method a fax client application can call the IFaxPort::get_CanModify method to ensure that the client has permission to modify configuration information for the specified fax port.
HRESULT put_Tsid( BSTR newVal // new value for transmitting station identifier );
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.
When the fax service sends a fax on a specific port, the service transmits the TSID to the receiving device.
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.
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in faxcom.h.
Import Library: Included as a resource in faxcom.dll.
Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxPort, IFaxPorts, IFaxPort::get_Tsid, IFaxPort::CanModify