IFaxPort::get_Csid

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

Visual Basic Reference

HRESULT get_Csid(
  BSTR *pVal  // receives called station identifier string
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the called station identifier (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 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.

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

  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::put_Csid, SysFreeString