IXStudioSession::CreateFileIterator Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Creates a file iterator over the events in an Xbox Event File (XEF).

Syntax

public:
HRESULT CreateFileIterator(
         XSTUDIO_LOCATION location,
         const wchar_t *filePath,
         const GUID *pStreamTypes,
         UINT32 streamTypeCount,
         IXStudioFileIterator **ppIterator
)  

Parameters

location
Type: XSTUDIO_LOCATION 

[in] Location (console or development computer) of the Xbox Event File (XEF).

filePath
Type: wchar_t *

[in] Path and filename of the Xbox Event File (XEF).

pStreamTypes
Type: GUID *

[in] Array of GUIDs that specify the stream types to include in the iteration. To iterate events for the default stream types, use XSTUDIO_DEFAULT_NUI_RECORDING_STREAMS.

streamTypeCount
Type: UINT32 

[in] Number of stream type GUIDs in pStreamTypeGuids.

ppIterator
Type: IXStudioFileIterator **

[out] Pointer to an IXStudioFileIterator pointer that receives the iterator interface.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

Used for doing a playback from an XEF file to NUI streams. When done using the iterator interface, call Release.

Requirements

Header: Declared in xstudio.h.

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