| Contents: | Main | Chapter | See Also: | Getting Started Manual | Advanced User Manual | |||
This procedure retrieves one or more fields of data from a record or sub-record(s) and places the values in a target array.
GETS^DIQ(FILE,IENS,FIELD,FLAGS,TARGET_ROOT,MSG_ROOT)
| FILE |
(Required) File or subfile number. |
|
| IENS |
(Required) Standard IENS indicating internal entry numbers. |
|
| FIELD |
(Required) Can be one of the following:
|
|
| FLAGS |
(Optional) Flags to control processing. The possible values are: |
|
| E | Returns External values in nodes ending with "E". | |
| I | Returns Internal values in nodes ending with "I". (Otherwise, external is returned). | |
| N | Does not return Null values. | |
| R | Resolves field numbers to field names in target array subscripts. | |
| Z | Word processing fields include Zero nodes. | |
| A# | Audit Trail is used to retrieve the value of
'FIELD' at a particular point in time.
# is a date/time in FileMan internal format (e.g., 3021015.08). The values retrieved are the (audited) values of the field(s) as of that date/time. |
|
| TARGET_ROOT |
(Required) The name of a closed root reference. |
|
| MSG_ROOT |
(Optional) The name of a closed root reference that is used to pass error messages. |
|
| TARGET_ROOT |
The output array is in the FDA format, i.e., TARGET_ROOT(FILE,IENS,FIELD)=DATA. WP fields have data descendent from the field nodes in the output array. |
Example 1
Retrieve the values of all fields for a record.
>D GETS^DIQ(999000,"1,","**","","ARRAY")
>ZW
ARRAY(999000,"1,",.01)=TEST1
ARRAY(999000,"1,",1)=OCT 01, 1992
ARRAY(999000,"1,",2)=YES
ARRAY(999000,"1,",3)=1
ARRAY(999000,"1,",4)=DTM-PC
ARRAY(999000,"1,",5)=SUPPORTED
ARRAY(999000,"1,",6)=S Y="SET Y=TO THIS"
ARRAY(999000,"1,",8)=AUDIT,Z
ARRAY(999000,"1,",9)=ACCESS,Z
ARRAY(999000,"1,",10)=GRP,Z
ARRAY(999000,"1,",11)=DESCRIP,Z
ARRAY(999000,"1,",12)=ARRAY(999000,"1,",12)
ARRAY(999000,"1,",12,1)=THIS WP LINE 1
ARRAY(999000,"1,",12,2)=WP LINE2
ARRAY(999000,"1,",12,3)=AND SO ON
ARRAY(999000,"1,",13)=LASTNAME,FIRST
ARRAY(999000.07,"1,1,",.01)=TEST1 ONE
ARRAY(999000.07,"1,1,",1)=
ARRAY(999000.07,"2,1,",.01)=TEST1 TWO
ARRAY(999000.07,"2,1,",1)=
ARRAY(999000.07,"3,1,",.01)=TEST1 THREE
ARRAY(999000.07,"3,1,",1)=
ARRAY(999000.07,"4,1,",.01)=TEST1 FOUR
ARRAY(999000.07,"4,1,",1)=MUMPS
Example 2
Retrieve the values of all fields for a record, excluding multiples.
>D GETS^DIQ(999000,"1,","*","","ARRAY1")
>ZW
ARRAY1(999000,"1,",.01)=TEST1
ARRAY1(999000,"1,",1)=OCT 01, 1992
ARRAY1(999000,"1,",2)=YES
ARRAY1(999000,"1,",3)=1
ARRAY1(999000,"1,",4)=DTM-PC
ARRAY1(999000,"1,",5)=SUPPORTED
ARRAY1(999000,"1,",6)=S Y="SET Y=TO THIS"
ARRAY1(999000,"1,",8)=AUDIT,Z
ARRAY1(999000,"1,",9)=ACCESS,Z
ARRAY1(999000,"1,",10)=GRP,Z
ARRAY1(999000,"1,",11)=DESCRIP,Z
ARRAY1(999000,"1,",12)=ARRAY(999000,"1,",12)
ARRAY1(999000,"1,",12,1)=THIS WP LINE 1
ARRAY1(999000,"1,",12,2)=WP LINE2
ARRAY1(999000,"1,",12,3)=AND SO ON
ARRAY1(999000,"1,",13)=LASTNAME,FIRST
Example 3
Retrieve both internal and external values of three specific fields for a record.
>D GETS^DIQ(999000,"1,",".01;3;5","IE","ARRAY3")
>ZW
ARRAY3(999000,"1,",.01,"E")=TEST1
ARRAY3(999000,"1,",.01,"I")=TEST1
ARRAY3(999000,"1,",3,"E")=1
ARRAY3(999000,"1,",3,"I")=1
ARRAY3(999000,"1,",5,"E")=SUPPORTED
ARRAY3(999000,"1,",5,"I")=
Example 4
Retrieve both internal and external values for a range of fields in a record.
>D GETS^DIQ(999000,"1,",".01:6","IE","ARRAY4")
>ZW
ARRAY4(999000,"1,",.01,"E")=TEST1
ARRAY4(999000,"1,",.01,"I")=TEST1
ARRAY4(999000,"1,",1,"E")=OCT 01, 1992
ARRAY4(999000,"1,",1,"I")=2921001
ARRAY4(999000,"1,",2,"E")=NO
ARRAY4(999000,"1,",2,"I")=0
ARRAY4(999000,"1,",3,"E")=66
ARRAY4(999000,"1,",3,"I")=66
ARRAY4(999000,"1,",4,"E")=DTM-PC
ARRAY4(999000,"1,",4,"I")=9
ARRAY4(999000,"1,",5,"E")=SUPPORTED
ARRAY4(999000,"1,",5,"I")=
ARRAY4(999000,"1,",6,"E")=S Y="SET Y=TO THIS"
ARRAY4(999000,"1,",6,"I")=S Y="SET Y=TO THIS"
Example 5
Retrieve the values of five specific fields, including all of the values of a multiple field.
>D GETS^DIQ(999000,"1,",".01;3;7*;11;13","","ARRAY5")
>ZW
ARRAY5(999000,"1,",.01)=TEST1
ARRAY5(999000,"1,",3)=1
ARRAY5(999000,"1,",11)=DESCRIP,Z
ARRAY5(999000,"1,",13)=LASTNAME,FIRST
ARRAY5(999000.07,"1,1,",.01)=TEST1 ONE
ARRAY5(999000.07,"1,1,",1)=
ARRAY5(999000.07,"2,1,",.01)=TEST1 TWO
ARRAY5(999000.07,"2,1,",1)=
ARRAY5(999000.07,"3,1,",.01)=TEST1 THREE
ARRAY5(999000.07,"3,1,",1)=
ARRAY5(999000.07,"4,1,",.01)=TEST1 FOUR
ARRAY5(999000.07,"4,1,",1)=MUMPS 0S
| 200 | There is an error in one of the variables passed. |
| 202 | Missing or invalid input parameter. |
| 301 | Flags passed are unknown or incorrect. |
| 309 | Either the root of the multiple or the necessary entry numbers are missing. |
| 348 | The passed value points to a file that does not exist or lacks a Header Node. |
| 401 | The specified file or subfile does not exist. |
| 403 | The file lacks a Header Node. |
| 404 | The file Header Node lacks a file #. |
| 501 | The field name or number does not exist. |
| 505 | The field name passed is ambiguous. |
| 510 | The data type for the specified field cannot be determined. |
| 520 | An incorrect kind of field is being processed. |
| 537 | Field has a corrupted pointer definition. |
| 601 | The entry does not exist. |
| 603 | A specific entry in a specific file lacks a value for a required field. |
| 648 | The value points to a file that does not exist or lacks a Header Node. |
Reviewed/Updated: October 2016