Print Page as PDF
XPDKEY ICR (1367)

XPDKEY    ICR (1367)

Name Value
NUMBER 1367
IA # 1367
DATE CREATED 1995/09/26
CUSTODIAL PACKAGE KERNEL
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XPDKEY
NAME XPDKEY
GENERAL DESCRIPTION
APIs and extrinsic functions that can be used to
control the Security Key File.
STATUS Active
KEYWORDS
  • SECURITY KEYS
  • KEYS
DURATION Till Otherwise Agreed
ID XPDKEY
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$RENAME
Usage:  S value=$$RENAME^XPDKEY(oldname,newname) Use
this entry point to rename a security key. All necessary indexing is performed
to maintain the ^XUSEC global.  The return value is 1 for OK, or 0 for
failure.
VARIABLES TYPE VARIABLES DESCRIPTION
oldname Input
Name of security key to be renamed.
newname Input
New name for security key.
value Output
return 1 if operation successful, 0 if operation
failed.
$$LKUP
Usage:  S value=$$LKUP^XPDKEY(key_value)

This extrinsic function will lookup a Security Key by name or by Internal
Entry Number (IEN) value.  If called with a number it returns the name of the
KEY.  If called with a name it returns the IEN number of the KEY.
VARIABLES TYPE VARIABLES DESCRIPTION
key_value Input
Security Key name or Internal Entry Number (IEN).
value Output
Returns either the Security Key name or IEN,
depending on the Input variable key_value.
DEL
Usage:  D DEL^XPDKEY(key_ien)

This call will delete a Security Key from the Security Key File.  All
necessary indexing is performed to maintain the ^XUSEC global.  The KEY is
removed from all holders in the NEW PERSON file.
VARIABLES TYPE VARIABLES DESCRIPTION
key_ien Input
The Internal Entry Number (IEN) of the Security Key
to delete.
DATE ACTIVATED 2008/03/12