DSICHFS ICR (5326)

Name

Value

NUMBER

5326

IA #

5326

DATE CREATED

2008/12/24

CUSTODIAL PACKAGE

VA CERTIFIED COMPONENTS - DSSI

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DSICHFS

NAME

DSICHFS

GENERAL DESCRIPTION

This routine contains various entry points for handling
HFS files. It can accomodate calling a VistA option that expects to write to a
printer or device.

STATUS

Active

DURATION

Till Otherwise Agreed

DSICHFS

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

ASKFILE

Interactive entry to prompt for file name file not
verified as to whether it exists or not.

Return user input or <null>

ASKPATH

Interactive entry to prompt for path name syntax of
path is not verified return user input or <null>.

Assumes you opened a HFS file using OPEN subroutine
for backward compatibility, the variable HANDLE can be set prior to calling
this line tag CLOSE.

DEL

Delete file(s).

VARIABLES

TYPE

VARIABLES DESCRIPTION

PATH

Input

Directory where file resides or is to be placed
default to $$PWD^%ZISH.

DSIDEL

Input

[.]DSIDEL - file or list of files to be deleted
DSIDEL=file_name or DSIDEL(file_name)="" or
DSIDEL(file_name_stub_"*")=""

FUN

Input

Boolean - if allowed & equal to 1 then TAG was called
as an extrinsic function, else it was called a DO (w/params).

DELALL

Delete all files starting with DSIC.

VARIABLES	TYPE	VARIABLES DESCRIPTION
PATH	Input	Directory where file resides or is to be placed default to $$PWD^%ZISH.

FTG

Get HFS file.

VARIABLES

TYPE

VARIABLES DESCRIPTION

DSICHFS

Output

Return variable for global or array.
DSICHFS(1)=Data Line #1
DSICHFS(2)=Data Line #2
DSICHFS(n)=Data Line #n

INPUT

Input

Expects ARR(varname)=value or ARR=var1^var2^var3,
where varname defined as follows:

CTRL - Boolean, if 1 strip ctrl chars from data, default=0
DEL - Default to 2
0: do not delete file created
1: delete file if transferred to global
2: delete file always
FILE - name of file to open or create.  If temp file is required
and FILE not passed then FILE will be generated
FUN - Boolean - if allowed & equal to 1 then TAG was called as
an extrinsic function, else it was called a DO (w/params)
HANDLE - string to be used when opening and closing files if the
%ZISUTL utility is called
MODE - default value is W [W:write  R:read  A:append]
PATH - directory where file resides or is to be placed
default to $$PWD^%ZISH
RTN - required only for GET call.  Indirect argument of DO
command.  Entry invoked must have no user interactions
VPG - page length, default to 66
VRM - right margin, default to 80

GET

multifunction API:

OPEN file, run a M routine, CLOSE file, MOVE file to @DSICHFS
Return file_name if process successful, else return -1^msg
Note: if RTN="EN1^DIP" then ^DIP will do its own OPEN command.  So
set up %ZIS(),IOP.  It is the calling program's responsibility
to set up all the Fileman input local variables except for IOP

VARIABLES

TYPE

VARIABLES DESCRIPTION

DSICHFS

Output

Return variable for global or array.
DSICHFS(1)=Data Line #1
DSICHFS(2)=Data Line #2
DSICHFS(n)=Data Line #n

INPUT

Input

Expects ARR(varname)=value or ARR=var1^var2^var3,
where varname defined as follows:

CTRL - Boolean, if 1 strip ctrl chars from data, default=0
DEL - Default to 2
0: do not delete file created
1: delete file if transferred to global
2: delete file always
FILE - name of file to open or create.  If temp file is required
and FILE not passed then FILE will be generated
FUN - Boolean - if allowed & equal to 1 then TAG was called as
an extrinsic function, else it was called a DO (w/params)
HANDLE - string to be used when opening and closing files if the
%ZISUTL utility is called
MODE - default value is W [W:write  R:read  A:append]
PATH - directory where file resides or is to be placed
default to $$PWD^%ZISH
RTN - required only for GET call.  Indirect argument of DO
command.  Entry invoked must have no user interactions
VPG - page length, default to 66
VRM - right margin, default to 80

LIST

Return file names or verify file exists.

VARIABLES	TYPE	VARIABLES DESCRIPTION
PATH	Input	Directory where file resides or is to be placed default to $$PWD^%ZISH.
FILE	Input	Name of file to open or create. If temp file is required and FILE not passed then FILE will be generated.
DSICIN	Input	If FILE is <null> then DSICIN or .DSICIN() must be passed If $D(DSICIN)=0 then FILE must be defined FILE or DSICIN or subscripts of DSICIN() must be full file names or file_name_stub_"*".
DSICOUT	Output	.DSICOUT() (Optional) passed by reference: Return array of file names found in directory defined in PATH.

OPEN

Open a HFS file and USE it.

VARIABLES	TYPE	VARIABLES DESCRIPTION
PATH	Input	Directory where file resides or is to be placed default to $$PWD^%ZISH.
FILE	Input	Name of file to open or create. If temp file is required and FILE not passed then FILE will be generated.
MODE	Input	default value is W [W:write R:read A:append].
VRM	Input	Right margin, default to 80.
VPG	Input	Page length, default to 66.

STRIP

Strip control characters from data in ROOT.

VARIABLES	TYPE	VARIABLES DESCRIPTION
ROOT	Input	(Required) $NAME of array where data is stored If data contains <TAB>, replace with 1-8 spaces. Not an extrinsic function call.

VER

Verify that file exists in path.

VARIABLES	TYPE	VARIABLES DESCRIPTION
PATH	Input	Directory where file resides or is to be placed; default to $$PWD^%ZISH.
FILE	Input	Name of file to open or create. If temp file is required and FILE not passed then FILE will be generated.

SUBSCRIBING PACKAGE

INSURANCE CAPTURE BUFFER

DATE ACTIVATED

2009/06/11