IXtfInputClient::DisconnectGamepad Method

Disconnects a specified virtual controller.

Syntax

public:
HRESULT DisconnectGamepad(
         UINT64 controllerId
)  

Parameters

controllerId
Type: UINT64

The device identifier of this IXtfInputClient.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

Call DisconnectGamepad when virtual controller operations are complete, to ensure that resources allocated for the virtual controller are freed. Every call to IXtfInputClient::ConnectGamepad should be paired with a call to DisconnectGamepad. Failure to disconnect a created gamepad will result in a memory leak. You may call IXtfInputClient::DisconnectAllGamepads to ensure that all virtual controllers are disconnected in order to avoid a memory leak.

Requirements

Header: xtfinput.h

Library: xtfinput.lib

Supported platforms: Windows (for Xbox console tools)

See also

XtfInput
IXtfInputClient
IXtfInputClient::ConnectGamepad
IXtfInputClient::DisconnectAllGamepads