Print Page as PDF
Classic FileMan API: Entry Deletion & File Reindexing ICR (10013)

Classic FileMan API: Entry Deletion & File Reindexing    ICR (10013)

Name Value
NUMBER 10013
IA # 10013
DATE CREATED 2001/12/04
CUSTODIAL PACKAGE 1
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE DIK
NAME Classic FileMan API: Entry Deletion & File Reindexing
ORIGINAL NUMBER 10013
GENERAL DESCRIPTION
Multiple entry points to support entry deletion and
file reindexing.
STATUS Active
ID DIK
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
IXALL
Reindexes all cross references for all entries in a
file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
The global root of the file to be indexed.
IX
Reindexes all cross references of the file for only
one entry in the file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are reindexing an entry at the top level of a
file, set DIK to the global root of the file.

If you are reindexing only a subentry, set DIK to the full global root leading
to the subentry, including all intervening subscripts and the terminating
comma, up to but not including the ien of the subfile entry to reindex.
DA Input
If you are reindexing an entry at the top level of a
file, set DA to the internal entry number of the file entry to reindex.

If you are reindexing an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to reindex, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
IX1
Reindexes all cross references of the file for only
one entry in the file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are reindexing an entry at the top level of a
file, set DIK to the global root of the file.

If you are reindexing a subentry, set DIK to the full global root leading to
the subentry, including all intervening subscripts and the terminating comma,
up to but not including the ien of the subfile entry to reindex.
DA Input
If you are reindexing an entry at the top level of a
file, set DA to the internal entry number of the file entry to reindex.

If you are reindexing an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to reindex, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
DIK
Used to delete an entry from a file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
The global root of the file from which you want to
delete an entry.

If you are deleting a subentry, set DIK to the full global root leading to the
subentry, including all intervening subscripts and the terminating comma, up
to but not including the ien of the subfile entry to delete.
DA Input
If you are deleting an entry at the top level of a
file, set DA to the internal entry number of the file entry to delete.

If you are deleting an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to delete, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
EN
Reindexes one or more cross references of a field for
one entry in a file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are reindexing an entry at the top level of a
file, set DIK to the global root of the file.

If you are reindexing a subentry, set DIK to the full global root leading to
the subentry, including all intervening subscripts and the terminating comma,
up to but not including the ien of the subfile entry to reindex.
DA Input
If you are reindexing an entry at the top level of a
file, set DA to the internal entry number of the file entry to reindex.

If you are reindexing an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to reindex, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
DIK(1) Input
Use the field number (to get all indices) or the
field number and specific indices of the cross reference.
EN1
Reindexes one or more cross references of a field for
one entry in a file.  It only executes the SET logic of the cross reference.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are reindexing an entry at the top level of a
file, set DIK to the global root of the file.

If you are reindexing a subentry, set DIK to the full global root leading to
the subentry, including all intervening subscripts and the terminating comma,
up to but not including the ien of the subfile entry to reindex.
DA Input
If you are reindexing an entry at the top level of a
file, set DA to the internal entry number of the file entry to reindex.

If you are reindexing an entry in a subfile, set up DA as an array, where
DA=entry number in the subfile to reindex, DA(1) is the entry number at the
next higher file level,...DA(n) is the entry number at the file's top level.
DIK(1) Input
Use the field number (to get all cross references) or
the field number and specific indices of the cross references you want.
ENALL
Reindexes all entries in a file for the cross
references on a specific field.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are reindexing an entries at the top level of
a file, set DIK to the global root of the file.

If you are reindexing subentries, set DIK to the full global root leading to
the subentry, including all intervening subscripts and the terminating comma,
up to but not including the iens of the subfile entries to reindex.
DIK(1) Input
Use the field number (to get all indices) or the
field number and specific cross references separated by up-arrows.
DA(1..n) Input
If you are reindexing entries in a subfile, set up DA
as an array, where DA(1) is the entry number at the next higher file
level,...DA(n) is the entry number at the file's top level. Since ENALL^DIK
reindexes all entries at a given file level, don't set the unsubscripted DA
node.
IX2
Executes the KILL logic for only one entry at all
file levels at or below the one specified in DIK.

Before calling this entry point, you should be familiar with the effects of
executing the kill logic of the relevant cross-references (including
bulletins, triggers, and MUMPS-type).
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are executing the kill logic for an entry at
the top level of a file, set DIK to the global root of the file.

If you are executing the kill logic for a subentry, set DIK to the full global
root leading to the subentry, including all intervening subscripts and the
terminating comma, up to but not including the IEN of the subfile entry.
DA Input
If you are executing the kill logic for an entry at
the top level of a file, set DA to the internal entry number of that file
entry.

If you are executing the kill logic for an entry in a subfile, set up DA as an
array, where DA is the entry number in the subfile, DA(1) is the entry number
at the next higher file level, etc. DA(n) is the entry number at the file's
top level.
IXALL2
Executes the KILL logic for all entries in a file.

Before calling this entry point, you should be familiar with the effects of
executing the kill logic of the relevant cross-references (including
bulletins, triggers, and MUMPS-type).

NOTE: IXALL^DIK, IXALL2^DIK, ENALL^DIK, ENALL2^DIK, and the Re-Index File
option on the Utility Functions menu set the 3rd piece of the 0 node of the
file's global root (the file header) to the last internal entry number used in
the file. They set the 4th piece to the total number of entries in the file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are executing the kill logic for all entries
at the top level of a file, set DIK to the global root of the file.

If you are executing the kill logic for all entries in a subfile only, set DIK
to the full global root of the subfile
DA Input
If you are executing the kill logic for all entries
at the top level of a file this variable need not be set.

If you are executing the kill logic for all entries in a subfile, set up DA as
an array, where DA(1) is the entry number at the next higher file level, DA(2)
is the entry number one level above that, etc. DA(n) is the entry number at
the file's top level.
EN2
Executes the KILL logic for one or more
cross-references on a specific field for one entry in a file.

Before calling this entry point, you should be familiar with the effects of
executing the kill logic of the relevant cross-references (including
bulletins, triggers, and MUMPS-type).
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are executing the kill logic for an entry at
the top level of a file, set DIK to the global root of the file.

If you are executing the kill logic for a subentry, set DIK to the full global
root leading to the subentry, including all intervening subscripts and the
terminating comma, up to but not including, the IEN of the subfile entry.
DA Input
If you are executing the kill logic for an entry at
the top level of a file, set DA to the internal entry number of that file
entry.

If you are executing the kill logic for an entry in a subfile, set up DA as an
array, where DA is the entry number in the subfile, DA(1) is the entry number
at the next higher file level, etc. DA(n) is the entry number at the file's
top level.
DIK(1) Input
Set DIK(1) to the field number (to get all
cross-references defined on that field). For example:

S DIK(1)=.01

OR, set DIK(1) to the field number and the names or numbers of specific
cross-reference on that field, all separated by up-arrows (^). For example,

S DIK(1)=".01^B"
S DIK(1)=".01^B^C"
S DIK(1)=".01^1^2"
ENALL2
Executes the KILL logic for one or more
cross-references on a specific field for all entries in a file.

Before calling this entry point, you should be familiar with the effects of
executing the kill logic of the relevant cross-references (including
bulletins, triggers, and MUMPS-type).

NOTE: IXALL^DIK, IXALL2^DIK, ENALL^DIK, ENALL2^DIK, and the Re-Index File
option on the Utility Functions menu set the 3rd piece of the 0 node of the
file's global root (the file header) to the last internal entry number used in
the file. They set the 4th piece to the total number of entries in the file.
VARIABLES TYPE VARIABLES DESCRIPTION
DIK Input
If you are executing the kill logic for all entries
at the top level of a file, set DIK to the global root of the file.

If you are executing the kill logic for all entries in a subfile only, set DIK
to the full global root of the subfile.
DA Input
If you are executing the kill logic for all entries
at the top level of a file, this variable need not be set.

If you are executing the kill logic for all entries in a subfile, set up DA as
an array, where DA(1) is the entry number at the next higher file level, DA(2)
is the entry number one level above that, etc. DA(n) is the entry number at
the file's top level.
DIK(1) Input
Set DIK(1) to the field number (to get all
cross-references defined on that field). For example:

S DIK(1)=.01

OR, set DIK(1) to the field number and the names or numbers of specific
cross-reference on that field, all separated by up-arrows (^). For example,

S DIK(1)=".01^B"
S DIK(1)=".01^B^C"
S DIK(1)=".01^1^2"