# IRfProgressReport Interface Reference

Inherits IUnknown.

List of all members.

## Public Member Functions
HRESULT | AddToolStatus ([in] BSTR tool,[out, retval] CONID *id)
HRESULT | SetToolStatusMessage ([in] CONID id,[in] BSTR message)
HRESULT | RemoveToolStatus ([in] CONID id)
HRESULT | GetStatusNode ([out, retval] IRsNode **ppNode)

## Detailed Description

Function set for working with progress reporting.

## Member Function Documentation

HRESULT IRfProgressReport::AddToolStatus | ( | [in] BSTR | tool,
|  | [out, retval] CONID * | id |
| ) |  |  |

AddToolStatus

Creates new status item in progress bar

Parameters:

  | tool | [in] name of new status item.

Returns:
  id [out,retval] returned connector id associated with new status item.

     if(FAILED(hRes = m_spReportFn->AddToolStatus(CComBSTR(L"Export"), &m_conId)))
      return hRes;

HRESULT IRfProgressReport::SetToolStatusMessage | ( | [in] CONID | id,
|  | [in] BSTR | message |
| ) |  |  |

SetToolStatusMessage

- Set new message to status item.

Parameters:

  | id | [in] status item identification.
  | message | [in] message to display in progress bar .

HRESULT IRfProgressReport::RemoveToolStatus | ( | [in] CONID | id | ) |

RemoveToolStatus

- Remove status item.

Parameters:

  | id | [in] identification of status item.

HRESULT IRfProgressReport::GetStatusNode | ( | [out, retval] IRsNode ** | ppNode | ) |

GetStatusNode

- Return status node that manages all status items.

Returns:
  ppNode [out,retval] interface to status manager node.