source: IHS-VA_UTILITIES-XB/trunk/XBDIQ0.m@ 830

Last change on this file since 830 was 642, checked in by Sam Habiel, 15 years ago

Modified directory structure; moved routines.

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