RemoteSystemSessionInfo 类

定义

命名空间:

Windows.System.RemoteSystems

包含有关远程会话的标识信息。

public ref class RemoteSystemSessionInfo sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class RemoteSystemSessionInfo final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class RemoteSystemSessionInfo

Public NotInheritable Class RemoteSystemSessionInfo

继承

Object Platform::Object IInspectable RemoteSystemSessionInfo

属性

ContractVersionAttribute MarshalingBehaviorAttribute

Windows 要求

设备系列	Windows 10 Creators Update (在 10.0.15063.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v4.0 中引入)
应用功能	remoteSystem

示例

请参阅下面的代码示例，了解发现远程会话的完整过程 (包括获取对 RemoteSystemSessionInfo 实例) 的引用。

// Discover an existing shared experience.
public void DiscoverExistingSessions() {

    // create a watcher for remote system sessions
    RemoteSystemSessionWatcher sessionWatcher = RemoteSystemSession.CreateWatcher();

    // register a handler for the "added" event
    sessionWatcher.Added += async (sender, args) => {

        // get a reference to the info about the discovered session
        RemoteSystemSessionInfo sessionInfo = args.RemoteSystemSessionInfo;

        // update the UI with the sessionInfo.DisplayName and 
        // sessionInfo.ControllerDisplayName strings. Save a reference to 
        // this RemoteSystemSessionInfo, to use when the user selects
        // this session from the UI

        //...
    };

    // Begin watching
    sessionWatcher.Start();
}

获取 RemoteSystemSessionInfo 引用后，可用于发出加入请求。 有关加入远程会话的过程，请参阅下面的代码示例。

public async void JoinExistingSession() {

    // request to join. sessionInfo has already been selected by user.
    RemoteSystemSessionJoinResult joinResult = await sessionInfo.JoinAsync();

    // process the result
    if (joinResult.Status == RemoteSystemSessionJoinStatus.Success) {

        // if the join was successful, acquire a reference to the session
        currentSession = joinResult.Session;

        // optionally handle the disconnected event
        currentSession.Disconnected += async (sender, args) => {
            // update the UI, using args.Reason
        };

        // update the UI with the session.DisplayName and 
        // session.ControllerDisplayName strings. Save a reference to 
        // this RemoteSystemSession, to use when the user selects
        // this session from the UI

    } else {
        // join request failed. optionally update UI
    }
}

注解

已加入的会话由 RemoteSystemSession 对象表示。 已知但尚未加入的会话由 RemoteSystemSessionInfo 对象表示。

属性

ControllerDisplayName	获取设备的计算机名称，该设备是远程会话的控制器。
DisplayName	获取远程会话的面向公众的名称，该名称由会话的控制器提供。

方法

JoinAsync()

从调用设备发出加入给定远程会话的请求。