IXStudioSession::GetConnectionStatus Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Returns the connection status of the session.

Syntax

public:
HRESULT GetConnectionStatus()  

Return value

Type: HRESULT 

S_OK if the connection is valid and functioning; an error code otherwise.

Remarks

Applications running on the console should not, and need not, call GetConnectionStatus. Doing so returns E_XSTUDIO_INVALID_OPERATION.

Call GetConnectionStatus only from an application running on the development computer, in order to determine the status of the connection to the target console.

Requirements

Header: Declared in xstudio.h.

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