IFaxPort::put_Csid

The IFaxPort::put_Csid method changes the Csid property for a FaxPort object. The Csid property is a null-terminated string that contains the called station identifier (CSID) associated with a fax port.

Before calling this method a fax client application can call the IFaxPort::get_CanModify method to ensure that the client has permission to modify the configuration information for the specified fax port.

Visual Basic Reference

HRESULT put_Csid(
  BSTR newVal  // new value for called station identifier string
);

Parameters

newVal

[in] Specifies the new value to assign as the CSID for the fax port.

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

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

Note that 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.

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, IFaxPort, IFaxPorts, IFaxPort::get_Csid, IFaxPort::CanModify