IXStudioFileIterator::SetLoopCount Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Sets the loop count, which indicates how many times the file is played back.

Syntax

public:
HRESULT SetLoopCount(
         UINT32 loopCount
)  

Parameters

loopCount
Type: UINT32 

The loop count.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

Note that the loop count can only be set before any events are retrieved from the file iterator. Once the iterator has been started, attempting to set loop count will return E_XSTUDIO_INVALID_OPERATION. If you wish to change the loop count, your code must first reset the iterator by using the Seek function with a value of zero.

A loop count of 1 will cause the file to be played back twice.

Requirements

Header: Declared in xstudio.h.

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