ExpertIndicateStatus

The ExpertIndicateStatus function indicates the percentage of completion of the expert's analysis of the capture file.

DWORD WINAPIExpertIndicateStatus(HEXPERTKEYhExpertKey,
EXPERTSTATUSENUMERATIONStatus,
DWORDSubStatus,
char*sztext,
longPercentDone);

Parameters

• hExpertKey
  [in] Unique expert identifier. Network Monitor passes hExpertKey to the expert when it calls the Run function.

• Status
  [in] Current status of the analysis. Specify one of the following EXPERTSTATUSENUMERATION values.

  Value	Meaning
  EXPERTSTATUS_INACTIVE	The expert never started.
  EXPERTSTATUS_STARTING	The expert is starting.
  EXPERTSTATUS_RUNNING	The expert is running normally.
  EXPERTSTATUS_PROBLEM	A problem specified in the SubStatus parameter stopped the expert.
  EXPERTSTATUS_ABORTED	Network Monitor stopped the expert.
  EXPERTSTATUS_DONE	The expert finished the analysis successfully.

• SubStatus
  [in] Extension or clarification of information provided by the Status parameter.

• sztext
  [in] Optional text status indicator.

  This parameter value may be NULL.

• PercentDone
  [out] Percentage of the capture data that the expert has processed.

  When the expert successfully completes analysis of a capture file, the system sets the percentage to 100. Any number greater than 99 will be ignored.

Return Values

If the function is successful, the return value is NMERR_SUCCESS.

If the function is unsuccessful, the return value is NMERR_EXPERT_TERMINATE; the expert must immediately clean up and return without completing the capture.

Remarks

The ExpertIndicateStatus function can only be called by experts that implement the Run or Configure export function.

Requirements

Client	Requires Windows XP, Windows 2000 Professional, or Windows NT Workstation 4.0.
Server	Requires Windows Server 2003, Windows 2000 Server, or Windows NT Server 4.0.
Header	Declared in Netmon.h.
Library	Link to Nmapi.lib.
DLL	Requires Nmapi.dll.