LegacyGipGameControllerProvider.IsCopilot(User, String) Method

Reference

Definition

Namespace:: Windows.Gaming.Input.Preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Retrieves the ID of the pilot controller if this controller is a copilot.

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

Parameters

user: User

User to check the pairing for.

controllerProviderId: String
Platform::String

winrt::hstring

Provider id for the controller to check for pairings.

Returns

String

Platform::String

winrt::hstring

The ID of the pilot controller if this controller is a copilot; otherwise, null.

Examples

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

Applies to

Share via