ExpertIndicateStatus function

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

Syntax

DWORD WINAPI ExpertIndicateStatus(
  _In_  HEXPERTKEY              hExpertKey,
  _In_  EXPERTSTATUSENUMERATION Status,
  _In_  DWORD                   SubStatus,
  _In_  char                    *sztext,
  _Out_ long                    PercentDone
);

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 value

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

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll