ESF API Return Codes

Collaboration diagram for ESF API Return Codes:

Modules
	ESF API Return Codes (safpb_api_rc)
	ESF Manager Return Codes (safpb_mgr_return)
	ESF Manager Reason Codes (safpb_mgr_reason)
Defines
#define	saf78_RS_PWRD_CHANGED   4
#define	saf78_RS_TOKEN_TOO_LARGE   12
#define	saf78_RC_PWRD_INVALID   8
#define	saf78_RS_PWRD_HISTORY   4
	password in history
#define	saf78_RC_USER_NOT_IN_GROUP   20
#define	saf78_RS_PORT   0
#define	saf78_RC_NOT_AUTH_FOR_APPL   52
#define	saf78_RS_MLACTIVE_REQUIRES   4
#define	saf78_RC_DEFAULT_TOKEN_USED   68
#define	saf78_RS_NODE_NOT_ALLOWED   0
#define	saf78_RS_SURROGATE_INACTIVE   4
#define	saf78_RC_JESJOBS_CHECK_FAIL   84
#define	saf78_RS_TOKEN_FORMAT   4
	malformed token
#define	saf78_RC_USER_IS_AUTH   0
#define	saf78_RS_RESOURCE_WARN   4
#define	saf78_RS_TAPE_VTOC   16
#define	saf78_RS_TAPE_CAN_VTOC   32
#define	saf78_RS_TAPE_NO_VTOC   36
#define	saf78_RC_ACCESS_INFO   20
#define	saf78_RS_ACCESS_NONE   0
#define	saf78_RS_ACCESS_READ   4
#define	saf78_RS_ACCESS_UPDATE   8
#define	saf78_RS_ACCESS_CONTROL   12
#define	saf78_RS_ACCESS_ALTER   16
#define	saf78_RS_NO_RESOURCE_PROF   0
	this resource is not defined in the ESM
#define	saf78_RC_USER_NOT_AUTH   8
#define	saf78_RS_PROTALL_NO_PROF   0
#define	saf78_RS_USER_ERASE   4
#define	saf78_RS_USER_TAPEVOL   8
#define	saf78_RS_USER_TAPE_DS   12
#define	saf78_RS_USER_TAPE_BLP   16
#define	saf78_RS_NON_CATALOGED   20
#define	saf78_RS_USER_AUTH_TRANQ   24
#define	saf78_RS_EXEC_ATTEMPT_READ   28
#define	saf78_RS_SECLABEL_NOT_DOM   32
#define	saf78_RS_SECLABEL_NEV_DOM   36
#define	saf78_RS_USER_NO_SECLABEL   40
#define	saf78_RS_COND_ACCESS   44
#define	saf78_RC_OLDVOL_ERROR   12
#define	saf78_RC_THIRD_PARTY_FAIL   16
#define	saf78_RC_NO_CLASS   8
#define	saf78_RC_INTERNAL_ERROR   12
#define	saf78_RC_PARAM_ERROR   16
#define	saf78_RS_EVENT_INVALID   0
#define	saf78_RS_QUAL_INVALID   4
#define	saf78_RS_BAD_LIST_VER   8
#define	saf78_RS_BAD_LIST_LEN   12
#define	saf78_RS_ENTITY_INVALID   16
#define	saf78_RC_NO_AUDIT_DONE   20
#define	saf78_RC_MACT_CINACT   4
#define	saf78_RC_MACT_NO_CLASS   8
#define	saf78_RC_MINACT_CACT   12
#define	saf78_RC_MINACT_CINACT   16
#define	saf78_RC_MINACT_NO_CLASS   20
#define	saf78_RC_NO_ESM   24
#define	saf78_RC_BAD_PARMLIST   28
#define	saf78_RS_ESM_DECLINED   4
#define	saf78_RC_KEYWORD_ERROR   4
#define	saf78_RS_KEYWORD_UNKNOWN   4
#define	saf78_RC_VALUE_ERROR   4
#define	saf78_RS_VALUE_INVALID   4
#define	saf78_RS_VALUE_LENGTH   8
#define	saf78_RC_DENIED   8
#define	saf78_SAF_RC_PARM_ERROR   12
#define	saf78_RC_VERSION   1
#define	saf78_RC_REQUEST   2
#define	saf78_RC_TYPE   3
#define	saf78_RC_MODIFIER   4
#define	saf78_RC_FLAG   5
#define	saf78_RC_CODESET   6
#define	saf78_RC_SAFESM_INDEX   7
#define	saf78_RC_USERID   8
#define	saf78_RC_PWRD   9
#define	saf78_RC_NEWPWRD   10
#define	saf78_RC_ENTITY   11
#define	saf78_RC_FACILITY   12
#define	saf78_RC_TRANSACTION   13
#define	saf78_RC_LOGSTR   14
#define	saf78_RC_QUERY_NAME   15
#define	saf78_RC_NEXT   16
#define	saf78_RC_RETURN_AREA   17
#define	saf78_RC_ACEE_PTR   18
#define	saf78_RC_GROUP   19
#define	saf78_RC_CLASS   20
#define	saf78_RC_STRING1   21
#define	saf78_RC_STRING2   22
#define	saf78_RC_PERMISSIONS   23
#define	saf78_RC_ARGSTR   24
#define	saf78_RC_ARGTBL   25
#define	saf78_RC_ARGTBL_KEYPTR   26
#define	saf78_RC_ARGTBL_KEYLEN   27
#define	saf78_RC_ARGTBL_VALPTR   28
#define	saf78_RC_ARGTBL_VALLEN   29
#define	saf78_RC_TICKET   30
#define	saf78_RC_TOKEN   31
#define	saf78_RC_LIST   32
#define	saf78_RS_BAD_POINTER   1
#define	saf78_RS_BAD_VALUE   2

---

Detailed Description

As the description of the safpb_parameter_block explains, the SAFROUTE function has a three-part return code, embedded in the parameter block. It includes a ESF API return code (safpb_parameter_block::safpb_api_rc), which indicates success or failure of the request; a ESF Manager or ESM Module return code (safpb_parameter_block::safpb_mgr_return), which if nonzero indicates why the request failed, or in some cases provides additional information for a successful request; and a reason code (safpb_parameter_block::safpb_mgr_reason), which provides additional detail.

For example, a successful return from a Verify request might set safpb_api_rc to saf78_SAF_RC_SUCCESS, safpb_mgr_return to saf78_RC_NORMAL, and safpb_reason to saf78_RS_NORMAL.

For more information, see Result Codes in the ESF API Parameter Block.