IFaxStatus::get_Csid

The IFaxStatus::get_Csid method retrieves the Csid property for the FaxStatus object of a parent FaxPort object. The Csid property is a string that contains called station identifier (CSID) information, typically the fax number of the receiving device.

Visual Basic Reference

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

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the CSID information for a fax job. The string is typically the telephone number associated with the receiving device, and it is transmitted to the sending device as part of the fax transmission.

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

If the CSID information is not available, the IFaxStatus::get_Csid method returns an empty string.

The IFaxStatus::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, IFaxStatus, SysFreeString