IFaxJob::get_Tsid method (faxcom.h)

Article
02/22/2024

The IFaxJob::get_Tsid property is a null-terminated string that contains the transmitting station identifier (TSID)) associated with the fax job.

This property is read-only.

Syntax

HRESULT get_Tsid(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

If the TSID is not available, IFaxJob::get_Tsid is an empty string.

You can use the UseDeviceTsid property to determine if the fax server is configured to permit user-specified TSIDs.

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.

IFaxJob::get_Tsid 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

Share via