LegacyGipGameControllerProvider.ClearPairing(User, String) Méthode

Définition

Espace de noms:

Windows.Gaming.Input.Preview

Supprime tous les jumelages de copilotes pour controllerId pour l’utilisateur donné.

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)

Paramètres

user

User

Utilisateur pour lequel effacer le jumelage.

controllerProviderId

String

Platform::String

winrt::hstring

ID de fournisseur pour le contrôleur à supprimer des analyses.

Exemples

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);
}

Remarques

Supprime le contrôleur donné de tous les jumelages où il s’agit d’un pilote ou d’un copilote pour l’utilisateur donné. Le contrôleur n’a pas besoin d’être connecté pour être non apparié. La suppression d’un contrôleur d’un appairage supprime entièrement l’appairage, c’est-à-dire que si un contrôleur est associé en tant que copilote à un autre contrôleur, la suppression du contrôleur copilote entraîne également la suppression de l’appairage pour le contrôleur pilote et vice versa.

Attention

Le jumelage Copilot est persistant à l’échelle du système pour l’utilisateur donné. Cette opération ne doit être effectuée qu’à la direction de l’utilisateur.