IFaxStatus::get_Description method (faxcom.h)
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
HRESULT get_Description(
BSTR *pVal
);
Parameters
pVal
Return value
None
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | faxcom.h |
| DLL | Faxcom.dll |
See also
Fax Service Client API Interfaces