Print Page as PDF
XPDUTL ICR (10141)

XPDUTL    ICR (10141)

Name Value
NUMBER 10141
IA # 10141
DATE CREATED 1994/04/11
CUSTODIAL PACKAGE KERNEL
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XPDUTL
NAME XPDUTL
ORIGINAL NUMBER 10141
GENERAL DESCRIPTION
The routine XPDUTL contains multiple calls to support
the Kernel Installation and Distribution System.  All of the calls can only be
used in the context of the KIDS software, during the installation of software,
unless noted differently in the describitions that follow.

The following calls can be used anywhere during the install process:
$$VERSION(X) ;X=package name or package namespace
;Returns the current Version number
** This call can be used outside of KIDs **

$$VER(X) ;X=Build name from Build file or Install file
;Returns version number

$$PKG(X) ;X=Build name from Build file or Install file
;Returns package name

$$PATCH(X) ;X=Patch from Install file, (aaaa*nn.nn*nnn)
;Return 1 if patch X was installed, 0 if not installed
** This call can be used outside of KIDs **

$$LAST(X,Y,Z) ;X=Package name or namespace, Y=Version (optional, current if
not supplied), Z=1 released patch (optional, last released patch)
;Returns Last Patch and Date applied to a package
;PATCH will include Seq # if a released patch is last
;PATCH #^DATE,  ("nnn^yyymmdd" or "nnn Seq #nn^yyymmdd")
;-1 will be returned if either Package or Version do not exist
;   or No patches have been applied
** This call can be used outside of KIDs **

$$INSTALDT(X,.Y) ;X=Name from Install file, variable passed by reference
;Returns all installs for X in Install file
;Return array in Y, Y=number of records in array
;Y(internal date/time) = TEST # ^ SEQ #
** This call can be used outside of KIDs **

The following function can only be used in the Environment Check Routine
$$RTNUP(X,Y) ;X=routine name, Y= 1-delete, 2-skip
;changes the install action of a routine to delete or skip
;Returns 1 if successfull, 0 for failure


The following calls can be used during the Pre-Install or Post-Install
routines: $$PRODE(XPDN,XPD) ;XPDN=protocol name, XPD=1-enable, 0-disable
;enable/disable protocols
;Returns 1 if successfull, 0 for failure

$$OPTDE(XPDN,XPD) ;XPDN=option name, XPD=1-enable, 0-disable
;enable/disable options
;Returns 1 if successfull, 0 for failure

MES(X) ;X=message or an array passed by reference
;write message to Install file

BMES(X) ;X=message or an array passed by reference
;add blank line before writing message to Install file

$$NEWCP(XPD,XPDC,XPDP) ;XPD=check point name, XPDC=call back, XPDP=parameters
;create new check point
;Returns ien of check point, 0 for error

$$UPCP(XPD,XPDP) ;XPD=check point name or ien, XPDP=parameters
;update check point
;Returns ien of check point, 0 for error

$$COMCP(XPD) ;XPD=check point name or ien
;complete check point
;Returns date/time of completion, 0 for error

$$VERCP(XPD) ;XPD=check point name or ien
;verify check point, returns 1=completed, 0=not
;Returns 1 for completed, 0 for not completed, -1 for doesn't exist

$$PARCP(XPD,XPDF) ;XPD=check point name or ien, XPDF="PRE" if you want a
;Pre-Install check point while your in the Post-Install routine
;Returns parameters of check point

$$CURCP(XPDF) ;XPDF flag - 0=externel, 1=internal
;Returns current check point


STATUS Active
KEYWORDS KIDS
ID XPDUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$VERSION(PKG)
Returns the current version number for the given
package
VARIABLES TYPE VARIABLES DESCRIPTION
PKG Input
Package namespace or name
$$PATCH(PATCH)
Returns 1 if the given patch exist and 0 if it
doesn't exist
VARIABLES TYPE VARIABLES DESCRIPTION
PATCH Input
Patch name from Install file, format=AAAA*NN.NN*NNN
$$VER(NAME)
Returns the version number for the given Build name
VARIABLES TYPE VARIABLES DESCRIPTION
NAME Input
Build name from Build file or Install file
$$PKG(NAME)
Returns the Package name or namespace for the given
Build name
VARIABLES TYPE VARIABLES DESCRIPTION
NAME Input
Build name from Build file or Install file
$$RTNUP(RTN,ACT)
Changes the install action of a routine to delete at
site or skip this routine.  This can only be used during the Environment
Check.  Returns 1 if successfull, or 0 for failure.
VARIABLES TYPE VARIABLES DESCRIPTION
RTN Input
Routine name
ACT Input
Action for the routine.  1=Delete at site,  2=Skip
this routine
$$PRODE(PROT,ACT)
Enable or Disable the given protocol during the
Pre-Install or Post-Install routine.
VARIABLES TYPE VARIABLES DESCRIPTION
PROT Input
Protocol name
ACT Input
1 = Enable this Protocol 0 = Disable this Protocol
$$OPTDE(OPT,ACT)
Enable or Disable the given option during the
Pre-Install or Post-Install routine.
VARIABLES TYPE VARIABLES DESCRIPTION
OPT Input
Option name
ACT Input
1 = Enable this Option 0 = Disable this Option
MES(X)
Writes the message X to the Install file.  Can used
during the Pre-Install or Post-Install routines.
VARIABLES TYPE VARIABLES DESCRIPTION
X Input
X can be a string or an array.  Each line of the
array will be a seperate line in the message. If X is an array, it must be
passed by reference.
BMES(X)
Write a blank line before the message X is written to
the Install file.  Can used during the Pre-Install or Post-Install routines.
VARIABLES TYPE VARIABLES DESCRIPTION
X Input
X can be a string or an array.  Each line of the
array will be a seperate line in the message. If X is an array, it must be
passed by reference.
$$NEWCP(CP,CB,PARM)
Create a new check point.  This can only be used in
the Pre-Install and Post-Install routines.
VARIABLES TYPE VARIABLES DESCRIPTION
CP Input
Check Point name.
CB Input
Call Back, this is the TAG^ROUTINE you want exeucted
for the given Call Back.
PARM Input
This is a value that can be used to track the
progress of your checkpoint.
$$UPCP(CP,PARM)
Update a check point with a new parameter value.
This can only be used in the Pre-Install and Post-Install routines.
VARIABLES TYPE VARIABLES DESCRIPTION
CP Input
Check Point name you want to update
PARM Input
Value you want to save for the given check point.
$$COMCP(CP)
Complete a check point.  This can only be used in the
Pre-Install and Post-Install routines. Return the date/time of completion, or
0 for error.
VARIABLES TYPE VARIABLES DESCRIPTION
CP Input
Check Point name you want to complete.
$$VERCP(CP)
Verify a check point, returns 1 if complete.  This
can only be used in the Pre-Install and Post-Install routines.
VARIABLES TYPE VARIABLES DESCRIPTION
CP Input
Check point name you want to verify.
$$PARCP(CP,FLAG)
Returns the patameters for the given check point
name.  The Flag is used only if you want to get the parameters from a
'Pre-Install' check point while your in the Post-Install routine.
VARIABLES TYPE VARIABLES DESCRIPTION
CP Input
Check Point name
FLAG Input
FLAG is optional, it is set to 'PRE' if you are in
the Post-Install routine and you want a 'Pre-Install' check point.
$$CURCP(FLAG)
Returns the current Check Point that in process.
VARIABLES TYPE VARIABLES DESCRIPTION
FLAG Input
This is used to determine if the current check point
should be return in external or internal format.  0 = external, 1 = internal.
$$LAST(PKG,VER,REL)
Returns the Patch # and Date of the last patch
applied to a package


VARIABLES TYPE VARIABLES DESCRIPTION
PKG Input
The Package name as stored in the Package File (#9.4)

VER Input
The version of the Package, optional, current version
will be used if not supplied

REL Input
A flag, optional, when set to 1, will only return the
last released patch.  Available in patch XU*8*559.


$$INSTALDT(INSTALL, .RESULT)
Returns an array of all the installs in the Install
file, #9.7, for INSTALL.  The array is formatted as RESULT(internal
date/time)= TEST # ^ SEQ #.



VARIABLES TYPE VARIABLES DESCRIPTION
INSTALL Input
The name of the entry in the Install file (#9.7)

RESULT Both
Array name, passed by reference, that will contain
the results.
It will look like:  RESULT(internal date/time) = TEST # ^ SEQ #.
The variable RESULT will be equal to the number of records in the array.

DATE ACTIVATED 2013/05/23