IXStudioTitleClient::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 available event from the custom title stream.

Syntax

public:
HRESULT GetNextEvent(
         UINT32 timeoutMilliseconds,
         IXStudioEvent **ppEvent
)  

Parameters

timeoutMilliseconds
Type: UINT32 

Time in milliseconds to wait before timing out.

ppEvent
Type: IXStudioEvent **

[out] A pointer to the next available event.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Requirements

Header: Declared in xstudio.h.

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