IDataCollectorSet::Stop method (pla.h)

Article
02/22/2024

Manually stops the data collector set.

Syntax

HRESULT Stop(
  [in] VARIANT_BOOL Synchronous
);

Parameters

[in] Synchronous

Data collection runs in a separate process. This value determines when the method returns.

Set to VARIANT_TRUE to have the method return after the data collector set is stopped or fails to stop. The return value indicates whether the set successfully stopped or failed to stop.

Set to VARIANT_FALSE to return after the method sends a request to the set to stop. The return value indicates whether the request was successfully sent to the set. An event is written to the event log if the set fails to stop.

Return value

Returns S_OK if successful. The following table shows a possible error value.

Return code/value	Description
PLA_E_DCS_NOT_RUNNING 0x80300104	The data collector set is not running.

Remarks

This method saves the data already collected when the set is stopped.

Note that if the Synchronous parameter is VARIANT_TRUE, the method will not return until data management and tasks that run after collection are complete.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	pla.h
DLL	Pla.dll