XBDIQ0 ; IHS/ADC/GTH - Documentation for XBDIQ1 ; [ 02/07/97 3:02 PM ]
;;3.0;IHS/VA UTILITIES;;FEB 07, 1997
;
; Documentation for XBDIQ1
;
; This routine provides a friendly front end to EN^DIQ1 and
; an assortment of other features.
;
; 1. Data arrays are returned into 'DIQ in a variety of
; formats controlled by the parameter set into DIQ(0).
; The default is 'DIQ(FLDNUM)= external value of field
; FLDNUM is the DD number of the field as used in DR.
;
; 2. Data retrieval is non-intrusive! Does not disturb the
; partition.
;
; 3. Input Variables used are the same as for EN^DIQ1 with
; more friendly results.
;
; 4. DR(filenumber and DA(filenumber arrays are
; automatically built when needed.
;
; ENTRY POINTS
;
; ENP^XBDIQ1(DIC,DA,DR,DIQ,DIQ(0))
; Returns 'DIQ(FLDNUM)= data for One Entry.
;
; ENPM^XBDIQ1(DIC,DA,DR,DIQ,DIQ(0))
; Returns 'DIQ(DA,FLDNUM)= data for Multiple Entries.
; DIC("S") can be set and used for screening entries.
;
; $$VAL^XBDIQ1(DIC,DA,DR)
; Returns External value of one field.
;
; $$VALI^XBDIQ1(DIC,DA,DR)
; Returns Internal value of one field.
;
; $$DIC^XBDIQ1(DIC) Returns constructed DIC from
; file/subfile number.
;
; PARSE^XBDIQ1(DA)
; Returns a DA array from a literal string made from
; Variables or Numbers mixed in descending order.
; EXMP: "1,DFN,56" => DA=56,DA(1)=34,DA(2)=1 where DFN=34
; also: S VAR(I)="1,DFN,56" D PARSE^XBDIQ1(VAR(I)) => as
; above.
;
; EN Returns one Entry (DR) fields.
; Needs DIC,DA,DR,DIQ,DIQ(0) as set up for
; calls to EN^DIQ1.
;
; ENM Returns Multiple Entry's (DR) fields
; 1) upper DA array ie: DA(1),DA(2), ...
; 2) DA="" in the passing array
; 3) optional DIC("S")
; Needs DIC,DA,DR,DIQ,DIQ(0) as set up for
; calls to EN^DIQ1.
; DIQ(0)=1 by default.
;
; DIQ(0) Format Options.
;
; DIQ(0) If DIQ(0) is not present the default is
; set to NULL.
;
; 0 OR NULL DIQ(FLD)=
; 1 DIQ(DA,FLD)=
; 2 DIQ(DA(x),..,DA,FLD)=
; nI DIQ(... ,FLD,"I")=internal value(s) returned
; nN NULL fields are not returned
;
; DA can be the array .DA or a literal string in descending
; order.
; "1,23,45"
; "1,PATDFN,BLDFN" variables will be unfolded.
; BARVDA("EOBSUB")
; ("EOBSUB")="BAFCLDA,BARITDA,BAREDA"
;
;
Q
;
XBDIQ0 ; IHS/ADC/GTH - Documentation for XBDIQ1 ; [ 02/07/97 3:02 PM ]
+1 ;;3.0;IHS/VA UTILITIES;;FEB 07, 1997
+2 ;
+3 ; Documentation for XBDIQ1
+4 ;
+5 ; This routine provides a friendly front end to EN^DIQ1 and
+6 ; an assortment of other features.
+7 ;
+8 ; 1. Data arrays are returned into 'DIQ in a variety of
+9 ; formats controlled by the parameter set into DIQ(0).
+10 ; The default is 'DIQ(FLDNUM)= external value of field
+11 ; FLDNUM is the DD number of the field as used in DR.
+12 ;
+13 ; 2. Data retrieval is non-intrusive! Does not disturb the
+14 ; partition.
+15 ;
+16 ; 3. Input Variables used are the same as for EN^DIQ1 with
+17 ; more friendly results.
+18 ;
+19 ; 4. DR(filenumber and DA(filenumber arrays are
+20 ; automatically built when needed.
+21 ;
+22 ; ENTRY POINTS
+23 ;
+24 ; ENP^XBDIQ1(DIC,DA,DR,DIQ,DIQ(0))
+25 ; Returns 'DIQ(FLDNUM)= data for One Entry.
+26 ;
+27 ; ENPM^XBDIQ1(DIC,DA,DR,DIQ,DIQ(0))
+28 ; Returns 'DIQ(DA,FLDNUM)= data for Multiple Entries.
+29 ; DIC("S") can be set and used for screening entries.
+30 ;
+31 ; $$VAL^XBDIQ1(DIC,DA,DR)
+32 ; Returns External value of one field.
+33 ;
+34 ; $$VALI^XBDIQ1(DIC,DA,DR)
+35 ; Returns Internal value of one field.
+36 ;
+37 ; $$DIC^XBDIQ1(DIC) Returns constructed DIC from
+38 ; file/subfile number.
+39 ;
+40 ; PARSE^XBDIQ1(DA)
+41 ; Returns a DA array from a literal string made from
+42 ; Variables or Numbers mixed in descending order.
+43 ; EXMP: "1,DFN,56" => DA=56,DA(1)=34,DA(2)=1 where DFN=34
+44 ; also: S VAR(I)="1,DFN,56" D PARSE^XBDIQ1(VAR(I)) => as
+45 ; above.
+46 ;
+47 ; EN Returns one Entry (DR) fields.
+48 ; Needs DIC,DA,DR,DIQ,DIQ(0) as set up for
+49 ; calls to EN^DIQ1.
+50 ;
+51 ; ENM Returns Multiple Entry's (DR) fields
+52 ; 1) upper DA array ie: DA(1),DA(2), ...
+53 ; 2) DA="" in the passing array
+54 ; 3) optional DIC("S")
+55 ; Needs DIC,DA,DR,DIQ,DIQ(0) as set up for
+56 ; calls to EN^DIQ1.
+57 ; DIQ(0)=1 by default.
+58 ;
+59 ; DIQ(0) Format Options.
+60 ;
+61 ; DIQ(0) If DIQ(0) is not present the default is
+62 ; set to NULL.
+63 ;
+64 ; 0 OR NULL DIQ(FLD)=
+65 ; 1 DIQ(DA,FLD)=
+66 ; 2 DIQ(DA(x),..,DA,FLD)=
+67 ; nI DIQ(... ,FLD,"I")=internal value(s) returned
+68 ; nN NULL fields are not returned
+69 ;
+70 ; DA can be the array .DA or a literal string in descending
+71 ; order.
+72 ; "1,23,45"
+73 ; "1,PATDFN,BLDFN" variables will be unfolded.
+74 ; BARVDA("EOBSUB")
+75 ; ("EOBSUB")="BAFCLDA,BARITDA,BAREDA"
+76 ;
+77 ;
+78 QUIT
+79 ;