Module returncodes

Common return codes.

This library provides an homogeneous return code list for Agent related APIs.

Here is the list of defined return codes:

• "RC_OK": Successful.
• "RC_NOT_FOUND": The referenced item does not exist or could not be found.
• "RC_OUT_OF_RANGE": An index or other value is out of range.
• "RC_NO_MEMORY": Insufficient memory is available.
• "RC_NOT_PERMITTED": Current user does not have permission to perform requested action.
• "RC_UNSPECIFIED_ERROR": An unspecified error happened.
• "RC_COMMUNICATION_ERROR": Communications error.
• "RC_TIMEOUT": A time-out occurred.
• "RC_WOULD_BLOCK": Would have blocked if non-blocking behavior was not requested.
• "RC_DEADLOCK": Would have caused a deadlock.
• "RC_BAD_FORMAT": Inputs or data are not formated correctly.
• "RC_DUPLICATE": Duplicate entry found or operation already performed.
• "RC_BAD_PARAMETER": Parameter is not valid.
• "RC_CLOSED": The file, stream or object was closed.
• "RC_IO_ERROR": An IO error occurred.
• "RC_NOT_IMPLEMENTED": This feature is not implemented.
• "RC_BUSY": The component or service is busy.
• "RC_NOT_INITIALIZED": The service or object is not initialized.
• "RC_END": The file, stream or buffer reached the end.
• "RC_NOT_AVAILABLE": The service is not available.

Type returncodes

returncodes.tonumber(code)	Converts a name into a numeric status.
returncodes.tostring(code)	Converts a numeric status into a name,

Type returncodes

Field(s)

returncodes.tonumber(code)

Converts a name into a numeric status.

Parameter

• code : a string representing the return code to be converted into a number

Return value

the integer representing the return code, or 1 if unknown.

returncodes.tostring(code)

Converts a numeric status into a name,

Parameter

• code : an integer representing the return code to be converted into a string

Return value

the string representing the return code, or nil if not found.