errref.script

Software Testing Automation Framework (STAF)的开发代码

.***************************************************************************
.* Software Testing Automation Framework (STAF)
.* (C) Copyright IBM Corp. 2001
.*
.* This software is licensed under the Common Public License (CPL) V1.0.
.****************************************************************************

.*************************-START-OF-PROLOG-****************************
.*
.*  File Name          : ErrRef SCRIPT
.*  Descriptive Name   : Software Test Automation Framework Error Reference
.*  Detail:
.*
.*     This file contains an Error Code Reference for STAF.
.*
.**************************-END-OF-PROLOG-*****************************
:ih1.error codes
:i2.STAF
:h1 id=retcode.API Return Codes
:note.In some shell environments, return codes above 255 may be returned modulo
256.  This can, in particular, cause service return codes (which range from
4000 upward) to be mistaken for (possibly) non-existant common STAF return
codes.  For example, if a service returned the return code 4010, this might
appear to be the return code 170 (4010 modulo 256) in a shell
environment.:enote.
:table id     = errtab
       headhi = 3
       frame  = box
       split  = yes
       cols   = '* 2* 4*'
       align  = 'c l l'.
:tcap.STAF API Return Codes
.*-----------------------------
:thd.
:c.Error Code
:c.Meaning
:c.Comment
:ethd.
.*-----------------------------
:row.
:c.:hp2.0:ehp2.
:c.No error
:c.
.*-----------------------------
:row.
:c.:hp2.1:ehp2.
:c.Invalid API
:c.This indicates that a process has tried to call an invalid internal STAF API.
If this error occurs, report it to the authors.
.*-----------------------------
:row.
:c.:hp2.2:ehp2.
:c.Unknown Service
:c.You have tried to submit a request to a service that is unknown to STAFProc.
Verify that you have correctly registered the service.
.*-----------------------------
:row.
:c.:hp2.3:ehp2.
:c.Invalid Handle
:c.You are passing an invalid handle to a STAF API.  Ensure that you are using
the handle you received when you registered with STAF.
.*-----------------------------
:row.
:c.:hp2.4:ehp2.
:c.Handle already exists
:c.This indicates that you are trying to register a process with one name when
that process has already been registered with a different name.  If you
register the same process multiple times, ensure that you use the same name
on each registration call.
:note.If you receive this error code when trying to perform an operation
other than registering a service, report it to the authors.
.*-----------------------------
:row.
:c.:hp2.5:ehp2.
:c.Handle does not exist
:c.You are trying to perform an operation on a handle that does not exist.
For example, you may be trying to stop a process, but you are specifying the
wrong handle.
.*-----------------------------
:row.
:c.:hp2.6:ehp2.
:c.Unknown Error
:c.An unknown error has occurred.  This error is usually an indication of an
internal STAF error.  If this error occurs, report it the authors.
.*-----------------------------
:row.
:c.:hp2.7:ehp2.
:c.Invalid Request String
:c.You have submitted an improperly formatted request to a service.  See the
appropriate section in this document for the syntax of the service's requests,
or contact the provider of the service.
:note.Additional information regarding the exact syntax error may be provided
in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.8:ehp2.
:c.Invalid Service Result
:c.This indicates an internal error with the service to which a request was
submitted.  If this error occurs, report it to the authors and the service
provider.
.*-----------------------------
:row.
:c.:hp2.9:ehp2.
:c.Rexx Error
:c.This indicates an internal error in an external Rexx service.  If this error
occurs, report it to the authors and the service provider.
:note.The actual Rexx error code will be returned in the result passed back
from the submit call.
.*-----------------------------
:row.
:c.:hp2.10:ehp2.
:c.Base OS Error
:c.This indicates that a base operating system error was encountered.
:note.The actual base operating system error code, and possibly additional
information about the error, will be returned in the result passed back
from the submit call.
.*-----------------------------
:row.
:c.:hp2.11:ehp2.
:c.Process Already Complete
:c.You are trying to perform an invalid operation on a process that has
already completed.  For example, you may be trying to stop the process or
register for a process end notification.
.*-----------------------------
:row.
:c.:hp2.12:ehp2.
:c.Process Not Complete
:c.You are trying to free process information for a process that is still
executing.
.*-----------------------------
:row.
:c.:hp2.13:ehp2.
:c.Variable Does Not Exist
:c.You are trying to get, remove, or resolve a variable that does not exist.
Remember that variables are case sensitive.  The name of the variable that
does not exist will be in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.14:ehp2.
:c.UnResolvable String
:c.You have requested to resolve a string that cannot be resolved.  This
indicates that you have exceeded the resolution depth of the VAR service.  The
most common cause of this is recursive variables definitions.
.*-----------------------------
:row.
:c.:hp2.15:ehp2.
:c.Invalid Resolve String
:c.The string you requested to be resolved has a non-matching left or right
curly brace.  Ensure that all variable references have both left and right
curly braces.
.*-----------------------------
:row.
:c.:hp2.16:ehp2.
:c.No Path To Endpoint
:c.This indicates that STAFProc was not able to submit the request to
the requested endpoint (i.e. machine).  This error usually indicates that STAF
is not running on the target machine, or that the requested endpoint is not
valid, or that the network interface or port for the requested endpoint is not
supported.  Alternatively, you may need to increase your CONNECTTIMEOUT value
for the network interface and/or increase your CONNECTATTEMPTS value in your
STAF.cfg file.
.*-----------------------------
:row.
:c.:hp2.17:ehp2.
:c.File Open Error
:c.This indicates that there was an error opening the requested file.
Some possible explanations are that the file/path does not exist, contains
invalid characters, or is locked.
:note.Additional information regarding which file could not be opened may be
provided in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.18:ehp2.
:c.File Read Error
:c.This indicates that there was an error while trying to read data from a file.
:note.Additional information regarding which file could not be read from may be
provided in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.19:ehp2.
:c.File Write Error
:c.This indicates that there was an error while trying to write data to a file.
:note.Additional information regarding which file could not be written to may
be provided in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.20:ehp2.
:c.File Delete Error
:c.This indicates that there was an error while trying to delete a file or
directory.
:note.Additional information regarding which file or directory could not be
deleted may be provided in the result passed back from the submit call.
.*-----------------------------
:row.
:c.:hp2.21:ehp2.
:c.STAF Not Running
:c.This indicates that STAF is not running on the local machine.  Verify that
STAFProc.exe is running.
:p.
If STAFProc is running, make sure you are using the correct name for the
STAFProc instance you are trying to communicate with.  There is a special
environment variable, STAF_INSTANCE_NAME, that can be used to specify a name
for each STAFProc instance to differentiate between multiple instances of
STAF. If this environment variable is not set, the default value, "STAF", is
used for the instance name.
.*-----------------------------
:row.
:c.:hp2.22:ehp2.
:c.Communication Error
:c.This indicates an error transmitting data across the network, or to the
local STAF process.  For example, you would receive this error if STAFProc.exe
was terminated in the middle of a service request, or if a bridge went down
in the middle of a remote service request.
.*-----------------------------
:row.
:c.:hp2.23:ehp2.
:c.Trustee Does Not Exist
:c.You have requested to delete a trustee, and the trustee does not exist.
Verify that you have specified the correct trustee.
.*-----------------------------
:row.
:c.:hp2.24:ehp2.
:c.Invalid Trust Level
:c.You have attempted to set a machine or default trust level to an invalid
level.  The valid trust levels are from zero to five.
.*-----------------------------
:row.
:c.:hp2.25:ehp2.