$$FILE^XLFSHAN(): Returns SHA Hash for Specified FileMan File or Subfile Entry
Reference Type: Supported, Category: Data Security,
ICR#: 6157
The $$FILE^XLFSHAN extrinsic function returns the SHA hash for a specified file entry. It uses the VA FileMan
GETS^DIQ API to extract the data from the file. The input parameters match the input parameters for
GETS^DIQ.
NOTE: The VA FileMan Developer’s Guide is located on the VDL at:
https://www.va.gov/vdl/application.asp?appid=5
NOTE: This API was released with Kernel Patch XU*8.0*657.
$$FILE^XLFSHAN(hashlen,filenum,iens[,field][,flags])
hashlen:
|
(required) The hash length in bits:
-
160 (SHA-1)
-
224 (SHA-224)
-
256 (SHA-256)
-
384 (SHA-384)
-
512 (SHA-512)
|
filenum:
|
(required) VA FileMan file or subfile number.
|
iens:
|
(required) Standard VA FileMan IENS indicating internal entry numbers, as documented in the
VA FileMan Developer’s Guide.
|
field:
|
(optional) Can be one of the following:
-
A single field number.
-
A list of field numbers, separated by semicolons.
-
A range of field numbers, in the form M:N; where M and N are the end points of the inclusive range. All field numbers within this range are retrieved.
-
Asterisk (*) for all fields at the top-level (no sub-Multiple record).
-
Double asterisk (**) for all fields including all fields and data in sub-Multiple fields.
-
Field number of a multiple followed by an * to indicate all fields and records in the sub-Multiple for that field.
If this parameter is not passed, it defaults to **, which extracts all fields.
|
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 VA FileMan internal format (e.g., 3021015.08). The values retrieved are the (audited) values of the fields as of that date/time.
|
returns:
|
Returns:
-
SHA hash—If successful.
-
Zero (0)—If the file could not be opened or found.
-
-1—If an error occurs.
|
>W $$FILE^XLFSHAN(512,200,"10000000407,")
8FE96A435D69989EFC30FC852260990BECB030247657B9CA1CDB9D103097B51792648254770D88E292592CC06C36D22C3E502F790050B8ADBB035C89F59FB8A7
|