RenderingSession.ConnectAsync(RendererInitOptions) Method
Definition
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.
Connect to the runtime on the server associated with this session.
public:
System::Threading::Tasks::Task<Microsoft::Azure::RemoteRendering::ConnectionStatus> ^ ConnectAsync(Microsoft::Azure::RemoteRendering::RendererInitOptions initOptions);public System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.ConnectionStatus> ConnectAsync (Microsoft.Azure.RemoteRendering.RendererInitOptions initOptions);member this.ConnectAsync : Microsoft.Azure.RemoteRendering.RendererInitOptions -> System.Threading.Tasks.Task<Microsoft.Azure.RemoteRendering.ConnectionStatus>Public Function ConnectAsync (initOptions As RendererInitOptions) As Task(Of ConnectionStatus)Parameters
- initOptions
- RendererInitOptions
Connection parameters.
Returns
A task with a result of the new connection status. The returned task will complete in the Update() tick.
Remarks
* A AlreadyConnected error occurs, if another session in the same process is already connected to its runtime. * A InProgress error occurs, if Connect has been called before. * A OtherSessionConnected error occurs, if another session is already connected to this runtime. * A NoConnection error occurs, if no connection could be established. * A InvalidParam error occurs if the rendering service URL was empty, because the account domain and account Id was not provided. * A SessionNotFound error occurs if the corresponding session could not be found. Please check the provided session Id. * A AuthenticationFailed error occurs if the request could not be authenticated. * A NotInitialized error occurs if the RemoteRenderingClient or RenderingSession was not initialized. * A TooManyRequests error occurs if the rate limit has been exceeded. Retry the request after the duration given in the Retry-After header. * A DomainUnreachable error occurs if remote rendering domain is unreachable. Url may be invalid or Azure Remote Rendering is not supported in this region. * A ConnectionRefused error occurs if remote rendering connection is refused by destination host. * A ConnectionFailed error occurs if remote rendering connection failed. Exact reason is unknown. * A Timeout error occurs if remote rendering connection timed out. * A UnsupportedDisplayAdapter error occurs if an unsupported display adapter is detected.