Typical Result Codes for Admin

For an Admin request, the most common result code triplets are listed in the table below. These will generally be suitable for most ESM Modules.

An Admin request can succeed or fail, or it can be ignored if the ESM Module does not implement the requested administration subcommand. (If the module determines that it cannot process the request because of an unsuitable or missing parameter, it can fail or ignore the request as the author feels is appropriate.) The return codes below are classified as Success, Failure, or Ignored results.

rc return reason Meaning
saf78_SAF_RC_SUCCESS (0) saf78_RC_NORMAL (0) saf78_RS_NORMAL (0) The request was processed, no additional information (this is a Success result)
saf78_SAF_RC_NOT_COMPLETE (4) saf78_RC_NO_DECISION (0) saf78_RS_ESM_NOT_CALLED (0) The ESM Module does not implement this procedure (this is an Ignored result)
saf78_SAF_RC_NOT_COMPLETE (4) saf78_RC_NO_DECISION (0) saf78_RS_ESM_DECLINED (4) The ESM Module declined to process the request (this is an Ignored result)
saf78_SAF_RC_NOT_COMPLETE (4) saf78_RC_KEYWORD_ERROR (4) saf78_RS_KEYWORD_UNKNOWN (4) The request specified a parameter keyword that the ESM Module does not recognize (this is an Ignored result)
saf78_SAF_RC_FAILURE (8) saf78_RC_VALUE_ERROR (4) saf78_RS_VALUE_INVALID (4) The request specified a parameter value that is not valid for this ESM Module or its ESM (this is a Failure result)
saf78_SAF_RC_FAILURE (8) saf78_RC_VALUE_ERROR (4) saf78_RS_VALUE_LENGTH (8) The request specified a parameter value that was too long or short for this ESM Module or its ESM (this is a Failure result)
saf78_SAF_RC_FAILURE (8) saf78_RC_DATABASE_ERROR (92) saf78_RS_NORMAL (0) The ESM Module or its associated ESM was unable to process the request (this is a Failure result)