Difference between revisions of "IC Python API:RLPy RStatus"
From Reallusion Wiki!
Chuck (RL) (Talk | contribs) m |
Chuck (RL) (Talk | contribs) m |
||
| Line 84: | Line 84: | ||
==== Returns ==== | ==== Returns ==== | ||
:Return the internal status code - int | :Return the internal status code - int | ||
| − | *RLPy.RStatus.Success | + | :*RLPy.RStatus.Success |
| − | *RLPy.RStatus.Failure | + | :*RLPy.RStatus.Failure |
| − | *RLPy.RStatus.InsufficientMemory | + | :*RLPy.RStatus.InsufficientMemory |
| − | *RLPy.RStatus.LicenseFailure | + | :*RLPy.RStatus.LicenseFailure |
| − | *RLPy.RStatus.IncompatibleVersion | + | :*RLPy.RStatus.IncompatibleVersion |
| − | *RLPy.RStatus.InvalidParameter | + | :*RLPy.RStatus.InvalidParameter |
| − | *RLPy.RStatus.UnknownParameter | + | :*RLPy.RStatus.UnknownParameter |
| − | *RLPy.RStatus.NotImplemented | + | :*RLPy.RStatus.NotImplemented |
| − | *RLPy.RStatus.Deprecated | + | :*RLPy.RStatus.Deprecated |
| − | *RLPy.RStatus.NotFound | + | :*RLPy.RStatus.NotFound |
| − | *RLPy.RStatus.EndOfFile | + | :*RLPy.RStatus.EndOfFile |
<syntaxhighlight lang="Python"> | <syntaxhighlight lang="Python"> | ||
Revision as of 23:50, 22 March 2020
- Main article: Modules.
- Last modified: 03/22/2020
Description
This class facilitates error handling for each API. It encapsulates the status code as a return value for each API function. Developers can query, set, or output status codes through this class. The RStatus codes and their instructions are listed below:
| Constant | Value |
|---|---|
| RStatus.Success | The operation was successful. |
| RStatus.Failure | The operation failed. |
| RStatus.InsufficientMemory | The operation failed due to insufficient memory. |
| RStatus.LicenseFailure | Application is not licensed for the attempted operation. |
| RStatus.IncompatibleVersion | The applied operation is not compatible with the current version. |
| RStatus.InvalidParameter | An invalid parameter was provided. |
| RStatus.UnknownParameter | The operation was called with an unrecognized argument. |
| RStatus.NotImplemented | This operation has not been implemented. |
| RStatus.Deprecated | This operation has been deprecated. |
| RStatus.NotFound | Not currently used. |
| RStatus.EndOfFile | Not currently used. |
status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
if status == RLPy.RStatus.Success:
print("sucess") # print sucess
if status == RLPy.RStatus.Failure:
print("failure")
status.Clear()
print(status.IsError()) # False
if status.GetStatusCode() == RLPy.RStatus.Success:
print("sucess") # print sucess
print(status.IsError())
Member Functions
Clear( self )
Clear the current error status. Success status code is returned upon calling this function.
See also: IsError( self )
status = RLPy.RGlobal.SetTime(RLPy.RTime(1000))
if status == RLPy.RStatus.Failure:
print("failure")
status.Clear()
print(status.IsError()) # False
GetStatusCode ( self )
Get the current status code. Refer to the status code table above.
Returns
- Return the internal status code - int
- RLPy.RStatus.Success
- RLPy.RStatus.Failure
- RLPy.RStatus.InsufficientMemory
- RLPy.RStatus.LicenseFailure
- RLPy.RStatus.IncompatibleVersion
- RLPy.RStatus.InvalidParameter
- RLPy.RStatus.UnknownParameter
- RLPy.RStatus.NotImplemented
- RLPy.RStatus.Deprecated
- RLPy.RStatus.NotFound
- RLPy.RStatus.EndOfFile
if status.GetStatusCode() == RLPy.RStatus.Success:
print("sucess") # print sucess
IsError( self )
Check whether the current status is an error.
Returns
- true: An error has occured.
- false: No error.
if status == RLPy.RStatus.Failure:
print(status.IsError()) #True
