Stop

  • Article

Stops a recording in file logging mode.

Syntax

HRESULT Stop
  ([in] BSTR bstrFileName,
  [in] IProfileCollection* pProfileCollection,
  [in] ITraceMergeProperties* pTraceMergeProperties)
;

Parameters

bstrFileName
[in] The name of the file to which merged events from recordings of all the profiles are saved.

pProfileCollection
[in] A pointer to an IProfileCollection object that contains a collection of profiles to save.

pTraceMergeProperties
[in] A pointer to an ITraceMergeProperties object that contains properties with which to merge recordings.

Return Value

The following table describes possible return values.

Return Value Description

S_OK

The function successfully stopped the recording.

E_INVALIDARG

One or more arguments are invalid.

E_WPRC_FAILED_TO_STOP_PROFILE

The library failed to stop a profile in the profile collection. Use IControlErrorInfo to obtain detailed error information.

E_WPRC_TRACE_MERGE_LOST_EVENTS

The Event Tracing for Windows (ETW) session lost events, and merging the event trace log (ETL) files from the session may create incomplete ETL file.

Remarks

Use this function only for profiles that are logging sequentially to a file. After the sessions are saved, the recording stops.

IControlManager