LegacyGipGameControllerProvider.ClearPairing(User, String) Метод

Определение

Пространство имен:

Windows.Gaming.Input.Preview

Удаляет все пары copilot для controllerId для данного пользователя.

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)

Параметры

user

User

Пользователь, для который нужно очистить связывание.

controllerProviderId

String

Platform::String

winrt::hstring

Идентификатор поставщика для контроллера, удаляемого из синтаксического анализа.

Примеры

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

Комментарии

Удаляет заданный контроллер из всех сопряжений, где он является пилотным или копилотом для данного пользователя. Для непарного подключения контроллера не требуется. Удаление одного контроллера из связывания полностью удаляет связывание, то есть, если контроллер связан как копилот с другим контроллером, удаление контроллера copilot также приведет к удалению связывания для пилотного контроллера и наоборот.

Внимание!

Связывание Copilot является системным и постоянным для данного пользователя. Это следует делать только по указанию пользователя.