IFaxPort::get_Csid method (faxcom.h)

Article
07/27/2022

The IFaxPort::get_Csid property is a null-terminated string that contains the called station identifier (CSID) associated with the fax port.

This property is read/write.

Syntax

HRESULT get_Csid(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

Note Before setting a value for this property, a fax client application can call the IFaxPort::get_CanModify property to ensure that the client has permission to modify configuration information for the specified fax port.

Only printable characters such as English letters, numeric symbols, and punctuation marks (ASCII range 0x20 to 0x7F) can be used in a CSID.

When the fax service receives a fax on a port, the service transmits the CSID to the sending device.

The T.30 specification of the International Telecommunication Union (ITU) restricts the value of a CSID to 20 ASCII characters. If a fax client application specifies a CSID that contains non-ASCII characters, the fax service removes them. If the CSID exceeds 20 characters, the service truncates the extra characters.

IFaxPort::get_Csid 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