| Platform SDK: Fax Services |
The IFaxTiff::get_Csid method retrieves the Csid property for a FaxTiff object. The Csid property is a string that contains called station identifier (CSID) information, which is typically the fax number of the device that received the specified fax file.
A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.
HRESULT get_Csid( BSTR *pVal // receives called 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.
The IFaxTiff::get_Csid method sets the pVal parameter to the string that identifies the called device, if it is available. If the information is not available, the method returns an empty string.
The IFaxTiff::get_Csid 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, IFaxTiff, IFaxTiff::put_Image, SysFreeString