IFaxStatus::get_Tsid

The IFaxStatus::get_Tsid method retrieves the Tsid property for the FaxStatus object of a parent FaxPort object. The Tsid property is a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port.

Visual Basic Reference

HRESULT get_Tsid(
  BSTR *pVal  // receives transmitting station identifier string
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the transmitting station identifier (TSID) associated with the fax port that is sending a fax transmission. This identifier is typically the fax number for the port. The TSID is transmitted to the receiving device as part of a fax transmission.

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

The Tsid property is set for both inbound and outbound fax transmissions. If the TSID information is not available, the IFaxStatus::get_Tsid method returns an empty string.

The IFaxStatus::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

  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, IFaxStatus, IFaxPorts, IFaxPort, SysFreeString