LegacyGipGameControllerProvider.ClearPairing(User, String) Methode

Definition

Namespace:

Windows.Gaming.Input.Preview

Entfernt alle Copilot-Kopplungen für controllerId für den angegebenen Benutzer.

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)

Parameter

user

User

Benutzer, für den die Kopplung deaktiviert werden soll.

controllerProviderId

String

Platform::String

winrt::hstring

Anbieter-ID für den Controller, der aus Analysevorgängen entfernt werden soll.

Beispiele

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

Hinweise

Entfernt den angegebenen Controller aus allen Paarungen, bei denen es sich entweder um einen Pilot oder einen Copiloten für den angegebenen Benutzer handelt. Der Controller muss nicht verbunden werden, um entkoppelt zu werden. Wenn Sie einen Controller aus einer Kopplung entfernen, wird die Kopplung vollständig entfernt. Das heißt, wenn ein Controller als Copilot mit einem anderen Controller gekoppelt ist, entfernt das Entfernen des Copiloten-Controllers auch die Kopplung für den Pilotcontroller und umgekehrt.

Achtung

Die Copilot-Kopplung ist systemweit und persistent für den jeweiligen Benutzer. Dies sollte nur auf Die Anweisung des Benutzers erfolgen.