IXStudioFileIterator::SetInOutPoints Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Sets the ticks for the in and out points, which allow you to define a subrange of the file to iterate/playback.

Syntax

public:
HRESULT SetInOutPoints(
         UINT64 inPoint,
         UINT64 outPoint
)  

Parameters

inPoint
Type: UINT64 

The tick that defines the in point in the file.

outPoint
Type: UINT64 

The tick that defines the out point in the file.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

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

Requirements

Header: Declared in xstudio.h.

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