RtfwDeleteMonitorSession

RtfwDeleteMonitorSession deletes the specified wRTOS Monitoring session folder.

Syntax

Copy

bool RtfwDeleteMonitorSession(
    [in]    const TCHAR * session
);

Parameters

[in] session

A pointer to the name of the monitoring session folder to delete. This must be a simple name with no '\' characters that matches the name of a monitoring session folder in the session parent folder configured by RtfwSetMonitorConfiguration.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
ERROR_SHARING_VIOLATION	Monitoring is started and a session folder is in use by the wRTOS Subsystem, causing this function to fail.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib