Result#
- class omni.core.Result#
Bases:
pybind11_objectError code for the result of an operation.
The numeric encoding for values follows Microsoft’s <a href=”https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/0642cb2f-2075-4469-918c-4441e69c548a”> HRESULT</a> scheme. Many values are direct copies of those from the Windows API, such as ``kResultNotImplemented.`` Codes which are NVIDIA-provided, will have the mask ``0xa4310000.`` This comes from setting the “customer bit” (bit at most-significant index 2) and having a “facility” (bits from index 5-15) of ``0b10000110001`` aka ``0x431`` (which is ``”NVDA”`` in Morse Code).
Members:
SUCCESS : Operation successful. No error occurred.
NOT_IMPLEMENTED : The feature or method was not implemented. It might be at some point in the future.
OPERATION_ABORTED : The operation was aborted.
FAIL : The operation failed. * Decimal Value: -2147467259
NOT_FOUND : The item was not found. * Decimal Value: -2147024894
ACCESS_DENIED : Access has been denied for this operation.
OUT_OF_MEMORY : A system is out of memory. This does not necessarily mean resident memory has been exhausted (although it can), as this code can be used to special conditions such as exhausting graphics memory or running out of a specific memory pool. It can also indicate that an allocation would have been too big and failed ahead of time.
NOT_SUPPORTED : The operation is not supported. * Decimal Value: -2147024846
INVALID_ARGUMENT : One or more of the arguments passed to a given function was invalid.
INVALID_STATE : The system is in an invalid state to perform the operation. This is distinct from ``kResultInvalidOperation`` in that it covers situations like “system is not yet started” or “file is closed.” * Decimal Value: -2147024892
VERSION_CHECK_FAILURE : Version check failure. * Decimal Value: -2147024253
VERSION_PARSE_ERROR : Failed to parse the version. * Decimal Value: -2147024119
INSUFFICIENT_BUFFER : Insufficient buffer. * Decimal Value: -2147024774
TRY_AGAIN : Try the operation again.
INTERRUPTED : An operation was interrupted. An “interruption” happens in cases where the operation did not complete successfully due to an outside system (such as a timer) interrupting it. For example, a function ``Result wait_for(duration d)`` might give ``kResultSuccess`` when function returns because the duration expired and ``kResultInterrupted`` if the system is shutting down.
NO_INTERFACE : Interface not implemented. * Decimal Value: -2147467262
NULL_POINTER : Pointer is null.
ALREADY_EXISTS : Object already exists.
INVALID_OPERATION : The operation was not valid for the target. For example, attempting to perform a write operation on a read-only file would result in this error.
NO_MORE_ITEMS : No more items to return. This is meant for things like reader queues when they have run out of data and will never have more data. For cases where something like an async queue being temporarily empty, use ``kResultTryAgain.``
INVALID_INDEX : Invalid index.
NOT_ENOUGH_DATA : Not enough data.
TOO_MUCH_DATA : Too much data.
INVALID_DATA_TYPE : Invalid data type. This is used in cases where a specific type of data is requested, but that is not the data which the receiver has.
INVALID_DATA_SIZE : Invalid data size. This arises when the correct type of data is requested, but the requester believes the data size is different from the receiver. The cause of this is typically a version mismatch.
TIMED_OUT : Timed out.
WOULD_BLOCK : Would block.
Methods
__init__(self, value)Attributes
ACCESS_DENIEDALREADY_EXISTSFAILINSUFFICIENT_BUFFERINTERRUPTEDINVALID_ARGUMENTINVALID_DATA_SIZEINVALID_DATA_TYPEINVALID_INDEXINVALID_OPERATIONINVALID_STATENOT_ENOUGH_DATANOT_FOUNDNOT_IMPLEMENTEDNOT_SUPPORTEDNO_INTERFACENO_MORE_ITEMSNULL_POINTEROPERATION_ABORTEDOUT_OF_MEMORYSUCCESSTIMED_OUTTOO_MUCH_DATATRY_AGAINVERSION_CHECK_FAILUREVERSION_PARSE_ERRORWOULD_BLOCKvalue- __init__(self: omni.core._core.Result, value: int) None#
- property name#