IFaxStatus::get_Description

The IFaxStatus::get_Description method retrieves the Description property for the FaxStatus object of a parent FaxPort object. The Description property is a null-terminated string that describes the current status of the specified port.

Visual Basic Reference

HRESULT get_Description(
  BSTR *pVal  // receives description of port status
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains a description of the current status of the fax port. The string is suitable for display to users.

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 descriptive information is not available, the IFaxStatus::get_Description method returns an empty string.

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