| Platform SDK: Fax Services |
The IFaxDoc::get_Tsid method 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).
HRESULT get_Tsid( BSTR *pVal // receives transmitting station identifier string );
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.
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 IFaxServer::get_UseDeviceTsid method 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.
The IFaxDoc::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.
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, IFaxDoc, IFaxDoc::put_Tsid, IFaxServer::get_UseDeviceTsid, SysFreeString