RemoteRenderingClient.OpenRenderingSessionAsync(String) Method

Definition

Opens an existing rendering session.

public:
 System::Threading::Tasks::Task<Microsoft::Azure::RemoteRendering::CreateRenderingSessionResult ^> ^ OpenRenderingSessionAsync(System::String ^ sessionId);
public System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.CreateRenderingSessionResult> OpenRenderingSessionAsync (string sessionId);
member this.OpenRenderingSessionAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.CreateRenderingSessionResult>
Public Function OpenRenderingSessionAsync (sessionId As String) As Task(Of CreateRenderingSessionResult)

Parameters

sessionId
String

The UUID of a rendering session.

Returns

Task<CreateRenderingSessionResult>

The task result is of type CreateRenderingSessionResult which either holds a valid session reference or additional error context.

Remarks

The session id can be created through CreateNewRenderingSessionAsync(RenderingSessionCreationOptions), as well as through external tooling such as PowerShell.

Applies to