IFaxTiff::get_Csid method (faxcom.h)

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.

This property is read-only.

Syntax

HRESULT get_Csid(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

A fax client application must set the Image property before retrieving another property for a FaxTiff object.

The get_Csid method sets the pVal parameter to the string that identifies the called device, if that information is available. If the information is not available, the method returns "Unavailable".

The Csid property is a string that identifies the called device, if that information is available. If the information is not available, Csid is an empty string.

The 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.

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

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IFaxTiff

IFaxTiff::get_Image

SysFreeString