XINDX1.m

XINDX1 ;ISC/REL,GRK,RWF - ERROR ROUTINE ;08/05/08  13:59

 ;;7.3;TOOLKIT;**20,61,66,68,110,121,128,133,140,149,151,153**;Apr 25, 1995;Build 3

 ; Per VHA Directive 2004-038, this routine should not be modified.

 G A

E(ERR) ;

A N %,%1 ;TXT is the line of the error.

 S ERTX=LAB_$S(LABO:"+"_LABO,1:"")_$C(9),%1=$T(ERROR+ERR),ERTX=ERTX_$S(ERR:$P(%1,";",4,9),1:ERR) ;p110

 I ERTX["|" F %=1:1 S ERTX=$P(ERTX,"|")_$S($D(ERR(%)):ERR(%),1:"??")_$P(ERTX,"|",%+1,99) Q:ERTX'["|"

 ;check exclude rtn list

B I $P(%1,";",3)]"" D  Q:%1]""  ;Don't flag kernel doing kernel.

 . S %1=$P(%1,";",3)

 . F  S %=$P(%1,",") Q:$E(RTN,1,$L(%))=%  S %1=$P(%1,",",2,99) ;RTN must begins with %1, instead of contains ;p151

 . Q

 I ERR=17,$E(RTN)'="%",$E(LAB)="%" Q  ;Don't flag %RTN w/o %.

 ;Global is Error Line,tab,error tag,tab,error text

 S %=$G(^UTILITY($J,1,RTN,"E",0))+1,^(0)=%,^(%)=TXT_$C(9)_ERTX

 Q

 ;p149 change error 65 from S to W

 ;p153 add error 66 - ICR reference

 ;F = Fatal, S = Standard, W = Warning, I = Info

 ;;exclude rtn;error text

ERROR ;

1 ;;;F - UNDEFINED COMMAND (rest of line not checked).

2 ;;X,Z,DI,DD,KMP;F - Non-standard (Undefined) 'Z' command.

3 ;;X,Z,DI,DD,KMP;F - Undefined Function.

4 ;;;F - Undefined Special Variable.

5 ;;;F - Unmatched Parenthesis.

6 ;;;F - Unmatched Quotation Marks.

7 ;;;F - ELSE Command followed by only one space.

8 ;;;F - FOR Command did not contain '='.

9 ;;;I - QUIT Command followed by only one space.

10 ;;;F - Unrecognized argument in SET command.

11 ;;;W - Invalid local variable name.

12 ;;;W - Invalid global variable name.

13 ;;;W - Blank(s) at end of line.

14 ;;;F - Call to missing label '|' in this routine.

15 ;;;W - Duplicate label. (M57)

16 ;;;F - Error in pattern code.

17 ;;Z;W - First line label NOT routine name.

18 ;;;W - Line contains a CONTROL (non-graphic) character.

19 ;;;S - Line is longer than 245 bytes.

20 ;;X,Z,DI,DD,KMP;S - View command used.

21 ;;;F - General Syntax Error.

22 ;;X,Z,DI,DD,KMP;S - Exclusive Kill.

23 ;;X,Z,DI,DD,KMP;S - Unargumented Kill.

24 ;;;S - Kill of an unsubscripted global.

25 ;;;S - Break command used.

26 ;;X,Z,DI,DD,KMP;S - Exclusive or Unargumented NEW command.

27 ;;X,Z,DI,DD,KMP;S - $View function used.

28 ;;X,Z,DI,DD,KMP;S - Non-standard $Z special variable used.

29 ;;X,Z,DI,DD,KMP;S - 'Close' command should be invoked through 'D ^%ZISC'.

30 ;;;S - LABEL+OFFSET syntax.

31 ;;X,Z,DI,DD,KMP;S - Non-standard $Z function used.

32 ;;X,Z,DI,DD,KMP;S - 'HALT' command should be invoked through 'G ^XUSCLEAN'.

33 ;;X,Z,DI,DD,KMP;S - Read command doesn't have a timeout.

34 ;;X,Z,DI,DD,KMP;S - 'OPEN' command should be invoked through ^%ZIS.

35 ;;;S - Routine exceeds SACC maximum size of 20000 (|).

36 ;;X,Z,DI,DD,KMP;S - Should use 'TASKMAN' instead of 'JOB' command.

37 ;;;F - Label is not valid.

38 ;;;F - Call to this |

39 ;;X,Z,DI;S - Kill of a protected variable (|).

40 ;;;S - Space where a command should be.

41 ;;X,Z,DI,DD,KMP;I - Star or pound READ used.

42 ;;;W - Null line (no commands or comment).

43 ;;;F - Invalid or wrong number of arguments to a function.

44 ;;;S - 2nd line of routine violates the SAC.

45 ;;X,Z,DI,DD,KMP;S - Set to a '%' global.

46 ;;;F - Quoted string not followed by a separator.

47 ;;;S - Lowercase command(s) used in line.

48 ;;;F - Missing argument to a command post-conditional.

49 ;;;F - Command missing an argument.

50 ;;Z;S - Extended reference.

51 ;;;F - Block structure mismatch.

52 ;;;F - Reference to routine '^|'. That isn't in this UCI.

53 ;;;F - Bad Number.

54 ;;X,Z,DI,DD,KMP;S - Access to SSVN's or $SYSTEM restricted to Kernel.

55 ;;;S - Violates VA programming standards.

56 ;;;S - Patch number '|' missing from second line.

57 ;;;S - Lower/Mixed case Variable name used.

58 ;;;S - Routine code exceeds SACC maximum size of 15000 (|).

59 ;;;F - Bad WRITE syntax.

60 ;;X,Z,DI,DD,KMP;S - Lock missing Timeout.

61 ;;X,Z,DI,DD,KMP;S - Non-Incremental Lock.

62 ;;;S - First line of routine violates the SAC.

63 ;;;F - GO or DO mismatch from block structure (M45).

64 ;;;F - Cache Object doesn't exist.

65 ;;X,Z,DI,DD,KMP;W - Vendor specific code is restricted.]

66 ;;;S - Incorrect format for ICR Reference

--- Routine Detail   --- with STRUCTURED ROUTINE LISTING ---XINDX1   4131     printed  Apr 09, 2024@21:42:52                                                                                                                                                                                                      Page 2

XINDX1    ;ISC/REL,GRK,RWF - ERROR ROUTINE ;2018-03-01  10:01 AM

 +1       ;;7.3;TOOLKIT;**20,61,66,68,110,121,128,133,10001**;Apr 25, 1995;Build 4

 +2       ; Original Routine authored by Department of Veterans Affairs

 +3       ; 65 added in *10001* by OSEHRA/Sam Habiel in 2018

 +4        GOTO A

E(ERR)    ;

A         ;TXT is the line of the error.

           NEW %,%1

 +1       ;p110

           SET ERTX=LAB_$SELECT(LABO:"+"_LABO,1:"")_$CHAR(9)

           SET %1=$TEXT(ERROR+ERR)

           SET ERTX=ERTX_$SELECT(ERR:$PIECE(%1,";",4,9),1:ERR)

 +2        IF ERTX["|"

               FOR %=1:1

                   SET ERTX=$PIECE(ERTX,"|")_$SELECT($DATA(ERR(%)):ERR(%),1:"??")_$PIECE(ERTX,"|",%+1,99)

                   if ERTX'["|"

                       QUIT 

 +3       ;check exclude rtn list

B         ;Don't flag kernel doing kernel.

           IF $PIECE(%1,";",3)]""

               Begin DoDot:1

 +1                SET %1=$PIECE(%1,";",3)

 +2       ;quit if RTN[%1 or null.

                   FOR 

                       if RTN[$PIECE(%1,",")

                           QUIT 

                       SET %1=$PIECE(%1,",",2,99)

 +3                QUIT 

               End DoDot:1

               if %1]""

                   QUIT 

 +4       ;Don't flag %RTN w/o %.

           IF ERR=17

               IF $EXTRACT(RTN)'="%"

                   IF $EXTRACT(LAB)="%"

                       QUIT 

 +5       ;Global is Error Line,tab,error tag,tab,error text

 +6        SET %=$GET(^UTILITY($JOB,1,RTN,"E",0))+1

           SET ^(0)=%

           SET ^(%)=TXT_$CHAR(9)_ERTX

 +7        QUIT 

 +8       ;

 +9       ;F = Fatal, S = Standard, W = Warning, I = Info

 +10      ;;exclude rtn;error text

ERROR     ;

1         ;;;F - UNDEFINED COMMAND (rest of line not checked).

2         ;;X,Z,DI,DD,KMP;F - Non-standard (Undefined) 'Z' command.

3         ;;X,Z,DI,DD,KMP;F - Undefined Function.

4         ;;;F - Undefined Special Variable.

5         ;;;F - Unmatched Parenthesis.

6         ;;;F - Unmatched Quotation Marks.

7         ;;;F - ELSE Command followed by only one space.

8         ;;;F - FOR Command did not contain '='.

9         ;;;I - QUIT Command followed by only one space.

10        ;;;F - Unrecognized argument in SET command.

11        ;;;W - Invalid local variable name.

12        ;;;W - Invalid global variable name.

13        ;;;W - Blank(s) at end of line.

14        ;;;F - Call to missing label '|' in this routine.

15        ;;;W - Duplicate label. (M57)

16        ;;;F - Error in pattern code.

17        ;;Z;W - First line label NOT routine name.

18        ;;;W - Line contains a CONTROL (non-graphic) character.

19        ;;;S - Line is longer than 245 bytes.

20        ;;X,Z,DI,DD,KMP;S - View command used.

21        ;;;F - General Syntax Error.

22        ;;X,Z,DI,DD,KMP;S - Exclusive Kill.

23        ;;X,Z,DI,DD,KMP;S - Unargumented Kill.

24        ;;;S - Kill of an unsubscripted global.

25        ;;;S - Break command used.

26        ;;X,Z,DI,DD,KMP;S - Exclusive or Unargumented NEW command.

27        ;;X,Z,DI,DD,KMP;S - $View function used.

28        ;;X,Z,DI,DD,KMP;S - Non-standard $Z special variable used.

29        ;;X,Z,DI,DD,KMP;S - 'Close' command should be invoked through 'D ^%ZISC'.

30        ;;;S - LABEL+OFFSET syntax.

31        ;;X,Z,DI,DD,KMP;S - Non-standard $Z function used.

32        ;;X,Z,DI,DD,KMP;S - 'HALT' command should be invoked through 'G ^XUSCLEAN'.

33        ;;X,Z,DI,DD,KMP;S - Read command doesn't have a timeout.

34        ;;X,Z,DI,DD,KMP;S - 'OPEN' command should be invoked through ^%ZIS.

35        ;;;S - Routine exceeds SACC maximum size of 20000 (|).

36        ;;X,Z,DI,DD,KMP;S - Should use 'TASKMAN' instead of 'JOB' command.

37        ;;;F - Label is not valid.

38        ;;;F - Call to this |

39        ;;X,Z,DI;S - Kill of a protected variable (|).

40        ;;;S - Space where a command should be.

41        ;;X,Z,DI,DD,KMP;I - Star or pound READ used.

42        ;;;W - Null line (no commands or comment).

43        ;;;F - Invalid or wrong number of arguments to a function.

44        ;;;S - 2nd line of routine violates the SAC.

45        ;;X,Z,DI,DD,KMP;S - Set to a '%' global.

46        ;;;F - Quoted string not followed by a separator.

47        ;;;S - Lowercase command(s) used in line.

48        ;;;F - Missing argument to a command post-conditional.

49        ;;;F - Command missing an argument.

50        ;;Z;S - Extended reference.

51        ;;;F - Block structure mismatch.

52        ;;;F - Reference to routine '^|'. That isn't in this UCI.

53        ;;;F - Bad Number.

54        ;;X,Z,DI,DD,KMP;S - Access to SSVN's or $SYSTEM restricted to Kernel.

55        ;;;S - Violates VA programming standards.

56        ;;;S - Patch number '|' missing from second line.

57        ;;;S - Lower/Mixed case Variable name used.

58        ;;;S - Routine code exceeds SACC maximum size of 15000 (|).

59        ;;;F - Bad WRITE syntax.

60        ;;X,Z,DI,DD,KMP;S - Lock missing Timeout.

61        ;;X,Z,DI,DD,KMP;S - Non-Incremental Lock.

62        ;;;S - First line of routine violates the SAC.

63        ;;;F - GO or DO mismatch from block structure (M45).

64        ;;;F - Cache Object doesn't exist.

65        ;;X,Z,DI,DD,KMP;S - Vendor specific code is not allowed (SACC 2.2.8)