IXStudioPlayback::Stop Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Stops playback.

Syntax

public:
HRESULT Stop()  

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

Stop stops a playback that is in the started or paused states.

If playback is already stopped, Stop does nothing and returns S_OK.

Requirements

Header: Declared in xstudio.h.

Library: Use xstudioclient.lib (console) or xstudioservice.lib (desktop).