Result Enum
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.
Generic result type used by the Remote Rendering API.
public enum class Resultpublic enum Resulttype Result = Public Enum Result- Inheritance
-
Result
Fields
| Name | Value | Description |
|---|---|---|
| CoreReturnValueStart | -1 | Internal: Start of the range of core result values. |
| Success | 0 | Operation completed successfully. |
| Fail | 1 | General failure. |
| Cancelled | 2 | The user canceled the operation. |
| InvalidParam | 3 | Incorrect user input for the operation. |
| InvalidType | 4 | An object with incorrect type was passed in. |
| BufferTooSmall_Deprecated | 5 | Not used. |
| NoConnection | 6 | Operation requires an active connection. |
| ApiUnavailable | 7 | Internal. |
| AlreadyInitialized | 8 | Static initialization of remote rendering has been called multiple times. |
| AlreadyDeinitialized | 9 | Static de-initialization of remote rendering has already been performed. |
| StringTooLong | 10 | The string passed into the API is longer than allowed. |
| IndexOutOfRange | 11 | The index passed into the API is outside the valid range. |
| InProgress | 12 | An async operation has not yet finished. |
| NotInitialized | 13 | Static initialization of remote rendering hasn't been done yet. |
| StringNotValidUtf8 | 14 | The string passed into the API is not valid. |
| NotSupported | 15 | An operation is not supported on the target platform. |
| CoreReturnValueLast | 16 | Internal: Last used value of the range of core result values. |
| CoreReturnValueEnd | 200 | Internal: Maximum value of the range of core result values. |
| LoadFileReturnValueStart | 299 | Internal: Start of the range of file load result values. |
| FileNotFound | 300 | The requested file did not exist. |
| InvalidVersion | 301 | The requested file is either corrupt or uses an old version that is not supported anymore. |
| IncompatibleVersion_Deprecated | 302 | Not used. |
| FailedToOpenFile | 303 | The requested file is either corrupt or not recognized. |
| FileDownloadFailed | 304 | Downloading the file from the provided URI failed. |
| ExceedsMemoryLimit | 305 | Loading this model would exceed GPU memory limits. Request a larger server, or reduce the amount of loaded models. |
| CannotWriteTargetFile | 306 | The target file cannot be written |
| FileCorrupt | 307 | The target file is corrupt or in an unsupported format |
| FileUploadFailed | 308 | Internal: Uploading the file to the provided URI failed. |
| UnsupportedFileProvider | 309 | Internal: Files can only be up/downloaded from OneDrive or Azure Blob Storage. |
| LoadFileReturnValueLast | 310 | Internal: Last used value of the range of file load result values. |
| LoadFileReturnValueEnd | 500 | Internal: Maximum value of the range of file load result values. |
| ObjectReturnValueStart | 599 | Internal: Start of the range of object result values. |
| InvalidId | 600 | The provided object ID is not valid (anymore). |
| InvalidParentId | 601 | The parent entity with the provided ID does not exist. |
| AlreadyExists | 602 | An object of the same type already exists on the target. |
| CyclicReference | 603 | Re-parenting this entity to the target entity would create a cycle in the entity hierarchy. |
| ObjectLocked_Deprecated | 604 | Not used. |
| ObjectStatic | 605 | Tried to transform or re-parent an object that is part of a static scene graph. See 'SceneGraphMode=static' model conversion option. |
| ComponentLimitReached | 606 | Tried to add a component, but the maximum number of this component was already present. |
| FeatureUnsupportedInCompositionMode | 607 | Returned when trying to enable a feature that is not supported in the current rendering composition mode (see enum ServiceRenderMode) |
| ObjectReturnValueLast | 608 | Internal: Last used value of the range of object result values. |
| ObjectReturnValueEnd | 800 | Internal: Maximum value of the range of object result values. |
| ConnectionReturnValueStart | 899 | Internal: Start of the range of connection result values. |
| NoServerCertificate | 900 | Internal: Secure connection enabled, but certificate was missing, invalid, or not usable. |
| HandshakePortBusy | 901 | Internal: Handshake port could not be opened for accepting connections. |
| HandshakeUnreachable | 902 | Handshake server is unreachable. |
| HandshakeConnectionFailed | 903 | Handshake server closed the connection prematurely; likely due to TLS/Plain mismatch or invalid certificate. |
| AuthenticationFailed | 904 | Authentication with the handshake server failed. |
| RemotingVersionMismatch | 905 | No common compatible remoting version could be determined during handshake. |
| IncompatibleTransportProtocols | 906 | No common transport protocol could be determined during handshake. |
| HandshakeFailed | 907 | Handshake failed. Reason not further specified. |
| TransportPortBusy | 908 | Internal: Transport port could not be opened for accepting connections. |
| TransportUnreachable | 909 | Transport server is unreachable. |
| TransportConnectionFailed | 910 | Transport connection was closed before all communication channels had been set up. |
| ProtocolVersionMismatch | 911 | Transport connection was closed due to protocol version mismatch. |
| ProtocolError | 912 | A protocol error occurred that was severe enough to invalidate the current connection or connection attempt. |
| VideoCodecNotAvailable | 913 | Transport connection was closed due to the requested video codec not being available. |
| ConnectionLost | 914 | Connection has been closed by peer. |
| DeviceLost | 915 | Connection has been closed due to graphics device loss. |
| DisconnectRequest | 916 | Connection has been closed by request. |
| Timeout_Deprecated | 917 | Internal. |
| AlreadyConnected | 918 | A connection has been established before. |
| ArrVersionMismatch | 919 | The client SDK version is not supported anymore. Please update. |
| HandshakeNetworkUnreachable | 920 | Network is unreachable. This usually means the client knows no route to reach the remote host. |
| HandshakeConnectionRefused | 921 | No connection could be made because the remote side actively refused it. Usually this means that no host application is running. |
| VideoFormatNotAvailable | 922 | Transport connection was closed due to the requested video format not being available. |
| PeerDisconnectRequest | 923 | Disconnecting after receiving a disconnect request from the peer. |
| PeerDisconnectTimeout | 924 | Timed out while waiting for peer to close connection. |
| SessionOpenTimeout | 925 | Timed out while waiting for transport session to be opened. |
| RemotingHandshakeTimeout | 926 | Timed out while waiting for the remoting handshake to complete. |
| InternalError | 927 | Connection failed due to an internal error. |
| UnsupportedDisplayAdapter | 928 | Returned when trying to run remote rendering with an unsupported adapter like "Microsoft Basic Display Adapter". |
| ConnectionReturnValueLast | 929 | Internal: Last used value of the range of connection result values. |
| ConnectionReturnValueEnd | 1100 | Internal: Maximum value of the range of connection result values. |
| ManagerReturnValueStart | 1199 | Internal: Start of the range of manager result values. |
| InvalidToolId | 1200 | Internal: Invalid tool ID. |
| ManagerAlreadyCreated | 1201 | The remote rendering manager has already been created. |
| ManagerNotCreatedYet | 1202 | The remote rendering manager has not been created yet. |
| OtherSessionConnected | 1203 | Another session is already connected to this runtime. |
| BadStateTransition | 1204 | Internal. |
| FailedToStartTool | 1205 | An internal tool failed to start |
| InsufficientSlots | 1206 | Internal: Insufficient number of slots in Frontend. |
| PrepareRenderNotCalled | 1207 | PrepareRender has not been called before BlitRemoteFrame. |
| GraphicsBindingIncomplete | 1208 | GraphicsBinding incomplete. In case of OpenXR, the OpenXR instance has not been created yet. In case of WMR, the HolographicSpace has not been created yet or the device setup via HolographicSpace::SetDirect3D11Device has not called yet. Also, make sure to call StartupRemoteRendering before anything graphics related. |
| ManagerReturnValueLast | 1209 | Internal: Last used value of the range of manager result values. |
| ManagerReturnValueEnd | 1400 | Internal: Maximum value of the range of manager result values. |
| SessionReturnValueStart | 1499 | Internal: Start of the range of session result values. |
| InvalidToken | 1500 | The secure connection failed. Check the account settings. |
| InvalidUri | 1501 | The user provided URI is malformed. |
| SessionNotFound | 1502 | The session to the user provided session Id could not be found. |
| TooManyRequests | 1503 | Internal: The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header. |
| DomainUnreachable | 1504 | Remote rendering domain is unreachable. Url may be invalid or Azure Remote Rendering is not supported in this region. |
| ConnectionRefused | 1505 | Remote rendering connection refused by destination host. |
| ConnectionFailed | 1506 | Remote rendering connection failed. Exact reason unknown. |
| Timeout | 1507 | Remote rendering connection timeout. |
| OutOfCapacity | 1508 | Could not create a session of given size and region due to lack of capacity in the service. |
| SessionReturnValueLast | 1509 | Internal: Last used value of the range of session result values. |
| SessionReturnValueEnd | 1700 | Internal: Maximum value of the range of session result values. |