IFaxDoc::get_Tsid method (faxcom.h)

Article
07/27/2022

Sets or retrieves the Tsid property of a FaxDoc object. The Tsid property is a null-terminated string that contains a user-defined transmitting station identifier (TSID).

This property is read/write.

Syntax

HRESULT get_Tsid(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

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

If the fax server allows user-defined TSID strings, the service will transmit the value of pVal to the receiving fax device instead of the TSID associated with the sending device. You can use the UseDeviceTsid property to determine whether the fax server is configured to permit user-specified TSIDs.

The TSID is typically the fax number of the device sending the transmission. 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.

The get_Tsid method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	faxcom.h
DLL	Faxcom.dll