Share via


FaxStatus.Description property

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.

This property is read-only.

Syntax

Property Description As String

Property value

A String that receives a description of the current status of the fax port. The string is suitable for display to users.

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

Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Faxcom.h
DLL
Faxcom.dll

See also

FaxStatus

Fax Service Client API for Windows 2000

Fax Service Client API Interfaces

IFaxStatus

IFaxPorts

IFaxPort

SysFreeString