LegacyGipGameControllerProvider.IsCopilot(User, String) Méthode

Définition

Espace de noms:

Windows.Gaming.Input.Preview

Récupère l’ID du contrôleur pilote si ce contrôleur est un copilote.

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

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

public static string IsCopilot(User user, string controllerProviderId);

function isCopilot(user, controllerProviderId)

Public Shared Function IsCopilot (user As User, controllerProviderId As String) As String

Paramètres

user

User

Utilisateur pour lequel case activée le jumelage.

controllerProviderId

String

Platform::String

winrt::hstring

ID de fournisseur pour que le contrôleur case activée pour les paires.

Retours

String

Platform::String

winrt::hstring

ID du contrôleur pilote si ce contrôleur est copilote ; sinon, null.

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