IXStudioFileIterator::GetNextEvent Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Gets the next event from the file.

Syntax

public:
HRESULT GetNextEvent(
         IXStudioEvent **ppEvent
)  

Parameters

ppEvent
Type: IXStudioEvent **

[out] Pointer to an IXStudioEvent pointer that receives the event interface.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

Use the returned IXStudioEvent interface to query event information such as its size, index, and associated data.

When done using the event interface, call Release.

Requirements

Header: Declared in xstudio.h.

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