LegacyGipGameControllerProvider.ClearPairing(User, String) 方法

定義

命名空間:

Windows.Gaming.Input.Preview

拿掉指定使用者controllerId的任何 copilot 配對。

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

要從剖析中移除之控制器的提供者標識碼。

範例

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 的任何配對中移除指定的控制器。 控制器不需要連線才能取消配對。 從配對中移除一個控制器會完全移除配對，也就是說，如果控制器與另一個控制器配對，移除 Copilot 控制器也會移除試驗控制器的配對，反之亦然。

警告

Copilot 配對是指定使用者的全系統且永續性。 這應該只會在使用者的指示下完成。