"Fossies" - the Fresh Open Source Software Archive

Member "dx-4.4.4/help/dxall1377" (5 Feb 2002, 3473 Bytes) of package /linux/misc/old/dx-4.4.4.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 #!F-adobe-helvetica-medium-r-normal--18*
    2 #!N 
    3 #!N  #!Rdxse DXSetError, DXErrorReturn, DXErrorGoto #!N #!N 
    4 Function #!N #!N Set an error code and an explanatory message. 
    5 #!N #!N Syntax #!N  #!F-adobe-times-bold-r-normal--18*   #include <dx/dx.h> Error DXSetError(ErrorCode e, char 
    6 *message, ...) #define DXErrorReturn(e,s) {DXSetError(e,s); return ERROR;} #define DXErrorGoto(e,s) {DXSetError(e,s); goto 
    7 error;} #!EF #!N #!N Functional Details #!N #!N Modules that return 
    8  #!F-adobe-times-bold-r-normal--18*   ERROR #!EF should in many cases also set the error 
    9 code and error message.  #!F-adobe-times-bold-r-normal--18*   DXSetError #!EF provides the interface to 
   10 do this, and needs to be called only once for each 
   11 error. #!N #!N If a Data Explorer function returns an error 
   12 and sets an error code, the caller should usually return  #!F-adobe-times-bold-r-normal--18*   
   13 ERROR #!EF without using one of these routines, since the error 
   14 message set by the Data Explorer function will usually be more 
   15 informative. If the error code is set by the Data Explorer 
   16 function and the calling program proceeds without returning  #!F-adobe-times-bold-r-normal--18*   ERROR #!EF 
   17 ,  #!F-adobe-times-bold-r-normal--18*   DXResetError #!EF should be called. #!N #!N If the 
   18 Data Explorer function does not set the error code, it is 
   19 the calling function's responsibility to do so using one of these 
   20 routines. #!N #!N The  #!F-adobe-times-bold-r-normal--18*   message #!EF may be a  #!F-adobe-times-bold-r-normal--18*   
   21 printf #!EF format string, in which case additional arguments as required 
   22 by the format string must be specified. Messages beginning with the 
   23 pound sign,  #!F-adobe-times-bold-r-normal--18*   # #!EF , are reserved for system use. 
   24 #!N #!N Additional information can be added to an error message 
   25 using the  #!F-adobe-times-bold-r-normal--18*   DXAddMessage #!EF function. #!N #!N  #!F-adobe-times-bold-r-normal--18*   DXErrorReturn #!EF 
   26 calls  #!F-adobe-times-bold-r-normal--18*   DXSetError #!EF and returns from the caller with return 
   27 value  #!F-adobe-times-bold-r-normal--18*   ERROR #!EF . #!N #!N  #!F-adobe-times-bold-r-normal--18*   DXErrorGoto #!EF calls 
   28  #!F-adobe-times-bold-r-normal--18*   DXSetError #!EF and goes to the label "error." This is 
   29 useful when some clean-up activity is required (e.g., freeing allocated memory). 
   30 It is the caller's responsibility to provide the "error" label in 
   31 the code. #!N #!N The error code  #!F-adobe-times-bold-r-normal--18*   e #!EF must 
   32 be one of the following: #!CForestGreen #!N #!N  #!F-adobe-courier-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   #!N 
   33 ERROR_ASSERTION ERROR_INTERNAL ERROR_NO_CAMERA #!N ERROR_BAD_CLASS ERROR_INVALID_DATA ERROR_NO_MEMORY #!N ERROR_BAD_PARAMETER ERROR_MISSING_DATA ERROR_NOT_IMPLEMENTED 
   34 #!N ERROR_BAD_TYPE ERROR_UNEXPECTED #!EF #!EF #!N #!N #!EC #!N #!N Return 
   35 Value #!N #!N Always return  #!F-adobe-times-bold-r-normal--18*   ERROR #!EF . #!N #!N 
   36 See Also #!N #!N  #!F-adobe-times-bold-r-normal--18*    #!Ldxam,dxall1168 h DXAddMessage, DXMessageReturn, DXMessageGoto  #!EL  ,  #!Ldxmess,dxall1307 h DXMessage  #!EL  ,  #!Ldxre,dxall1359 h DXResetError  #!EL  , 
   37  #!Ldxw,dxall1407 h DXWarning  #!EL  #!EF #!N #!N  #!Lerrsec,dxall1094 h Error Handling and Messages  #!EL  . #!N #!N #!N  #!F-adobe-times-medium-i-normal--18*   Next 
   38 Topic #!EF #!N #!N  #!Ldxsetex,dxall1378 h DXSetErrorExit  #!EL  #!N  #!F-adobe-times-medium-i-normal--18*   #!N