LegacyGipGameControllerProvider.IsPilot(User, String) 方法

定义

命名空间:

Windows.Gaming.Input.Preview

如果此控制器是试点，则检索 copilot 控制器的 ID。

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

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

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

function isPilot(user, controllerProviderId)

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

参数

user

User

要为其检查配对的用户。

controllerProviderId

String

Platform::String

winrt::hstring

要检查配对的控制器的提供程序 ID。

返回

String

Platform::String

winrt::hstring

如果此控制器是试点，则为 copilot 控制器的 ID;否则为 null。

示例

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