LegacyGipGameControllerProvider.ClearPairing(User, String) 方法

定义

命名空间:

Windows.Gaming.Input.Preview

删除给定用户的 controllerId 的任何联用配对。

public:
 static void ClearPairing(User ^ user, Platform::String ^ controllerProviderId);

 static void ClearPairing(User const& user, winrt::hstring const& controllerProviderId);

public static void ClearPairing(User user, string controllerProviderId);

function clearPairing(user, controllerProviderId)

Public Shared Sub ClearPairing (user As User, controllerProviderId As String)

参数

user

User

要为其清除配对的用户。

controllerProviderId

String

Platform::String

winrt::hstring

要从分析中删除的控制器的提供程序 ID。

示例

public void CopilotSample(GipGameControllerProvider pilotProvider,
                                    GipGameControllerProvider copilotProvider)
{
    // Establish a copilot pairing for the given pilot and copilot providers
    string pilotId = GameControllerProviderInfo.GetProviderId(pilotProvider);
    string copilotId = GameControllerProviderInfo.GetProviderId(copilotProvider);
    User user = User.GetDefault();
    LegacyGipGameControllerProvider.PairPilotToCopilot(user, pilotId,
        copilotId);

    // Read copilot properties
    LegacyGipGameControllerProvider.IsPilot(user, pilotId); // Returns copilotId
    LegacyGipGameControllerProvider.IsPilot(user, copilotId); // Returns null
    LegacyGipGameControllerProvider.IsCopilot(user, pilotId); // Returns null
    LegacyGipGameControllerProvider.IsCopilot(user, copilotId); // Returns pilotId

    // Removes the pairing for both controllers
    LegacyGipGameControllerProvider.ClearPairing(user, pilotId);
    // Also removes the pairing for both controllers (unnecessary since the pairing was already removed)
    LegacyGipGameControllerProvider.ClearPairing(user, copilotId);
}

注解

从任何配对中删除给定控制器，其中该控制器是给定用户的试点或副驾驶。 控制器不需要连接，就可以不成对。 从配对中删除一个控制器会完全删除配对 - 也就是说，如果一个控制器作为副控制器与另一个控制器配对，删除该副控制器也会删除试点控制器的配对，反之亦然。

注意

对于给定的用户，Copilot 配对在系统范围内是永久性的。 这只能在用户的指导下完成。